1. Setup SKY Payments API
Make sure you have followed all the steps mentioned in the Blackbaud Payments API Getting Started instructions manual. If you already have then you skip this subsection. Here is a brief overview of the steps mentioned in the linked document:
- Step 1: Giving “Payments” access to your Blackbaud developer account.
- Step 2: Shows how to subscribe to the Payments API
- Step 3: Shows how to test your connection to the API and it also validates that Step 1,2 are completed successfully.
- Step 4: Shows how to use the API. A new SKY application Id needs to be created under your developer account.
- Step 5: Adding the SKY Application Id to the Blackbaud environment so that payments can be processed.
2. Obtain you Blackbaud Client Id ,Client Secret and set redirect URL
In order to get the public and secret key please log in to your Blackbaud instance and follow the steps below:
- Login to your Blackbaud instance.
- Click on your profile icon in top right corner and click on your name to open the account.
- Open your Blackbaud SKY Developer account.
- Select My applications from the Developer account options.
- Click and open the application that you want to be connected with Payments2Us.
If you don't already have an application then you can use the the following help guide to create one: https://developer.blackbaud.com/skyapi/docs/applications#create-an-application
Make sure you connect the application with your Blackbaud environment as well.
- Copy the OAuth client_Id and Primary OAuth client_secret for later use.
- On the same page add redirect URLs in the Redirect URIs section.
- By clicking on edit button, a pop-up will open where redirect URL can be added.
- If you are connecting Blackbaud with Salesforce's sandbox instance then add : https://test.salesforce.com/apex/AAkPay__OAuthReturnBlackbaud
- If you are connecting Blackbaud with Salesforce's production instance then add : https://login.salesforce.com/apex/AAkPay__OAuthReturnBlackbaud
3. Obtain Subscription Key
- In order to obtain the subscription key, perform the same steps as above or go to the step where "My applications" was selected.
- Instead of My applications , select My subscriptions.
- Go to My subscriptions, scroll down to the end and copy the primary access key for later use.
- If you don't see the keys then click on subscribe buttons first. Once the subscription is completed then you will be able to see the keys.
4. Scope and Subscription Configurations
- In My applications section make sure that data access is given in the Scopes section:
- In the My subscriptions section, make sure that access to Payments API is given:
5. Setup Payments2Us Merchant Facility
You can either edit and update the Merchant facility that was created as part of sample records or you can clone the sample merchant facility, rename it and update Blackbaud details in it. In the steps below the sample opportunity was cloned and it is being used:
- Navigate to the Merchant Facility tab in the payments2Us app.
- Click and open the sample or cloned merchant facility.
- Edit the merchant facility by clicking on Edit button or pencil icon against any of the field.
- Select "Blackbaud" from the Payment Gateway dropdown.
- Paste the OAuth client_id copied in step 1 in the Payment Gateway UserId.
- Paste the primary OAuth client_secret copied in step 1 in the Payment Gateway Password.
- PxPay/PxFusion UserId:
- Populate the exact name of payment configuration(merchant account) in the PxPay/PxFusion UserId field.
- You can review your payment configuration information within the Blackbaud Merchant Service User Guide.
- If you are a technical person you can fetch the existing Payment configurations in your blackbaud instance using Blackbaud's REST Endpoint.
- If the field is left blank or no payment configuration is found against the provided name then first active payment configuration will be used.
- Paste the subscription key copied in step 2 in the PxPay/PxFusion Password.
- Mark the merchant facility as Active.
- Mark the merchant facility as Primary.
- Set the environment to "Sandbox" or "Production" depending on if you are connecting with Blackbaud sandbox or production.
If the CSC level of the provided payment configuration name is not “None” then kindly review the Blackbaud - Payment Configuration CSC Level help article.
If you have cloned an existing Blackbaud merchant facility then it is necessary to authorise the new merchant facility as well.
6. Authorise Blackbaud
- After adding the information in the above step up, save the merchant facility.
- Now click on "Authorise Blackbaud" button from top right corner.
- This will open the Blackbaud login in a new tab, provide the login details.
- Once logged in successfully, it will redirected to authorisation screen. Click on Authorise.
- Once authorised it will redirect you to a Salesforce page, that is used to store the access token, refresh token.
- This page also fetches and stores the merchant account (payment configuration) and public key. Please don't close the tab.
After clicking on Authorise it might redirect you to Salesforce login page, if that is the case then add your salesforce credentials and login.
- Once completed it will automatically redirect to your Blackbaud merchant facility with a success toast message.
This step marks the completion of Blackbaud setup with Payments2Us.