Partner Payments API Integration

Stay secure and compliant when processing transactions through third parties. Work with Blackbaud Marketplace partners to process payments with the SKY Payments API Transaction endpoint.

This integration only applies to third-party applications available in the Marketplace.
Luminate Online API, Checkout API, Blackbaud Checkout API, and SKY Payments API are four separate API systems.
SKY Payments API is used instead of, not in addition to, Checkout API.
See How do I invite a user to Blackbaud.com and grant them access to Customer Support or Training (Blackbaud University) resources? for assistance gaining access to features and content that require signing in to your Blackbaud account.

Get your API key

In Luminate Online, select Setup, Site Options, Open API Configuration.

Screenshot of API COnfiguration page in Luminate Online Setup, Site Options

You will need this key value when making API calls.

Get your environment id

Log in to your Blackbaud account at app.Blackbaud.com.
Select Admin from the menu in the top, left.

Select your profile picture in the upper, right corner to view a list of environments to which you have access. Select the environment in which you will collect the donations.

Your environment id is part of the webpage URL. In some cases it will be appended with additional information. It begins after envid=, and ends either at an ampersand (&) or the end of the line.

Example URLs. Environment id starts after envid= and ends at an ampersand or the end of the line.

Your Blackbaud account provides access to settings you have permission to view or edit. Contact your site administrator if you need access to more settings.

You will need this environment id when making API calls.

Find or create your Blackbaud Merchant Services test account

Sign in to your Merchant Services account.
Select Control panel and Settings.

Open Control panel in the top navigation.

Select the arrow by Account configurations to expand the list. Select Edit from each listed configuration's menu to view the configuration settings.

Expander arrow at right side of the Account Configurations label.

Note the names of configurations with a Test Process mode. If no Test configurations exist, create one by following the instructions in Add an account configuration in the Blackbaud Merchant Services documentation.

You need the name of this test environment while connecting your application to the SKY API console application.

Find or create your Payments API role

Only a Payments administrator or an Organization administrator can access this feature area.

Sign into your Blackbaud account at app.Blackbaud.com and select Security.

Security may be on a tile or in the top nav depending on which screen you are in your account settings.

Select Role Management.

Select Payments roles.

Locate Payments API role under Payments Roles. If it does not exist, select New to create the role.

I see Payments roles but it does not contain a role.

Select + New.
Enter a role name and description, and select Access all endpoints under SKY API tasks.

Enter role name and description, and select Access all endpoints. Then save.

I do not see Payments roles.

An Organization or Payments API administrator must assign you the Payments API administrator role. To find an administrator:

Return to Security and select User management.
Identify any user with an Organization or Payments API Admin type.

Ask that person to assign you the Payments API administrator role.

The Payments administrator role differs from the API administrator role within the Payments feature area. The Payments administrator role allows you to edit roles in the Payments feature area. In contrast, the role within the Payments feature area grants access to the Payments SKY API endpoints.

Assign this second role to the developer responsible for your API integration.

Only assign the Payments administrator role to organization staff who need access to Payments settings for their job duties. The developer does not need the Payments administrator role to create your webpage or integrate with the APIs. For more details, refer to the Role-based Security Overview.

Assign the Payments API role

The developer creating the donation form and writing the code to integrate with the APIs must be assigned the role you found or created in the previous step. This is not the Payments administrator role. This is the role in Payments feature area which is created and managed by a Payments administrator.

Signin to app.Blackbaud.com.
Select Security and User management.
Select the developer's name from the list. If the developer does not appear on the list, select + Add user to add them.

select a name from the list or select add user above the list.

Select Manage roles.

Select Payments API, Make solution admin, and Save.

Connect the SKY API console application to your environment

From the menu in your Blackbaud account at app.Blackbaud.com, select Marketplace. If prompted, select the environment in which you will be collecting the donations.

Select Marketplace from the menu at the top, left.

Enter SKY API console in the search bar and press Enter.

Select SKY API console from the list of applications.
The application summary includes a status or options.
- A Connected label or Disconnect button indicate your environment is already connected. Proceed to the next step.
- A Get Started button indicates you lack the permissions to connect your environment to the application. Contact your Organization administrator.
- If displayed, select Connect and follow the instructions to connect to your environment.

Get Payments API subscription keys

Sign in to your Blackbaud developer account.
Select My subscriptions.
Select Subscribe.
Read the terms of use and select Submit to accept.
Review the subscription details.
- If desired, select Upgrade to increase the call limit.
- You may Show and copy the access keys when needed.

Do not share your keys and only store them in secure locations.

Collect donation information with the partner application using the Transaction Payments API call and collect the transactiontoken in the response.
When making the Payments API Transaction call, include the authorize_only parameter with a value of true. For recurring payments, also include the tokenize parameter set to true.
Validate the donation via validateDonateCheckout.
Record the transaction with donateCheckout.

REST

On this page