This article provides a complete guide to configuring the Blackbaud Merchant Services (BBMS) payment gateway in VanillaSoft. You can configure the Payment Gateway at either the account level or project level, allowing flexibility depending on your organizational needs. The configuration enables Callers to process payments securely through VanillaSoft. Please ensure that the Payments API is enabled for your BBMS account before proceeding. Contact Blackbaud support if it is not yet enabled.
Step 1: Add the VanillaSoft Application to Your Blackbaud Account
- Navigate to Blackbaud App Manager: Go to Blackbaud App Manager (you must log in to your Blackbaud administrator account to access).
- Connect the Application: Select Connect App and paste the Application ID: c5f1a2d9-01d7-4f07-bd5f-ac3660df1f72, then click Connect. The application will appear in the list of connected apps.
Note: Blackbaud recommends creating a dedicated user account specifically for authorizing Payments API requests. This prevents authorization issues when an individual account holder is unavailable.
Step 2: Add a User with the Payments Role
- Navigate to the Payments API Portal: Log into your Blackbaud environment and open the Payments API Portal.
-
Configure Payments Role:
- Go to the Security section, then the Roles tab.
- If no Payments role exists, click the plus sign to create one.
- Enter a role name and description, then under SKY API Tasks, select Access all endpoints.
- Click Save to finalize the role creation.
-
Add a User to the Payments Role:
- Navigate to the Users tab and click Add User.
- Enter the user’s name and email address, then select the Payments role from the drop-down list.
- Click Send Invite to email the user an invitation to access the role.
- Approve Application Access: Log in as the new user, navigate to the connected VanillaSoft application, and approve access on the user’s behalf.
Step 3: Configuring the Blackbaud Merchant Services Payment Gateway in VanillaSoft
Configuring for Your Entire VanillaSoft Account
-
Access Account Settings: From the Admin homepage, select Account in the top menu.
-
Open Payment Gateway Tab: Select the Payment Gateway tab from the top menu.
-
Enable Project-Specific Gateway (Optional): Check or uncheck the Enable a payment gateway to be set up for each individual Project checkbox as desired.
-
Select Payment Gateway: From the Payment Gateway drop-down, select Blackbaud Merchant Services (BBMS).
-
Authorize Gateway: If presented, click Authorize Gateway and log in to your Blackbaud account in the pop-up window.
- Note: If you don't see the login window, check if pop-ups are blocked in your browser settings.
-
Configure Gateway Options: Select the appropriate Gateway Options settings for Payment Configuration, Blackbaud Checkout, and Currency.
-
Integrate Raiser's Edge NXT (Optional): To integrate your Raiser's Edge NXT account, check the Use Raiser's Edge NXT checkbox and configure the desired options and details.
-
Configure Fields: In the Fields section, check the Required and Visible checkboxes beside the corresponding field names to set which fields are required and/or visible.
-
Save Settings: After configuring all options, click Save.
Configuring for an Individual Project
-
Select Project: From the Admin homepage, select the project you want to configure.
-
Access Payment Gateway Settings: Open the Integration menu and select Payment Gateway.
-
Select Payment Gateway: From the Payment Gateway drop-down, select Blackbaud Merchant Services (BBMS).
-
Authorize Gateway: If presented, click Authorize Gateway and log in to your Blackbaud account in the pop-up window.
- Note: If you don't see the login prompt, check if pop-ups are blocked in your browser settings.
-
Configure Gateway Options: Select the appropriate Gateway Options settings for Payment Configuration, Blackbaud Checkout, and Currency.
-
Integrate Raiser's Edge NXT (Optional): To integrate your Raiser's Edge NXT account, check the Use Raiser's Edge NXT checkbox and configure the desired options and details.
-
Configure Fields: In the Fields section, check the Required and Visible checkboxes beside the corresponding field names to set which fields are required and/or visible.
-
Save Settings: After configuring all options, click Save.
Step 4: Enabling the CC Payment Form for Callers
-
Select Project: From the Admin homepage, select the project where the payment gateway is configured.
-
Access Panel Layout: Open the Page Layout menu and select Panel Layout.
-
Select CC Payment Tab: Open the Available Tabs drop-down and select CC Payment.
-
Choose Panel Location: Open the Panel drop-down and select which panel you want the CC Payment tab to appear.
-
Add the CC Payment Tab: After selecting the panel, click the Add button to include the CC Payment tab.
-
Save Layout: Once everything is set, click Save.
By following these steps, you can configure the Blackbaud Merchant Services payment gateway in VanillaSoft for both account-wide and project-specific needs. For more detailed information or assistance, please refer to the official Blackbaud support resources.