Blackbaud Merchant Services (Preview)
Blackbaud Integrated Payments offers a comprehensive payment processing solution, integrating secure transactions and donor management for nonprofits and educational institutions.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Connector Metadata | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Website | https://www.blackbaud.com/products/blackbaud-integrated-payments |
| Privacy policy | https://www.blackbaud.com/privacy-shield |
| Categories | Sales and CRM;Productivity |
Blackbaud Integrated Payments is offers a comprehensive payment processing solution, integrating secure transactions and donor management for nonprofits and educational institutions.
This connector is built on top of Blackbaud's SKY API, and provides operations to help manage disbursements, transactions, and related entities found within Blackbaud Merchant Services.
For more information, please view the documentation.
Prerequisites
To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.
In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.
How to get credentials?
Your organization's administrator will send you an invitation to the organization's Blackbaud Merchant Services environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.
Known issues and limitations
The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.
Actions
| Get transaction details |
Returns information about a specific transaction. |
| List disbursement transactions |
Lists transactions for a specific disbursement. |
| List disbursements |
Lists disbursements for a payment configuration. |
Get transaction details
Returns information about a specific transaction.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Transaction ID
|
transaction_id | True | string |
The system record ID of the transaction. |
Returns
Transaction
List disbursement transactions
Lists transactions for a specific disbursement.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Payment configuration
|
payment_configuration_id | True | string |
The payment configuration. |
|
Disbursement
|
disbursement_id | True | string |
The disbursement containing the transactions to list. |
|
Page
|
page | True | integer |
Represents the page of records to return. The default is 1. The page size 1000. |
Returns
Transaction collection
List disbursements
Lists disbursements for a payment configuration.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Payment configuration
|
payment_configuration_id | True | string |
The payment configuration. |
|
Start date
|
start_date | date |
Filter the results to disbursements with start date on or after the specified date (ex: '2020-09-18'). |
|
|
End date
|
end_date | date |
Filter the results to disbursements with end date on or before the specified date (ex: '2020-09-18'). |
Returns
Disbursement collection
Definitions
PaymentsApi.BillingInfo
Billing info
| Name | Path | Type | Description |
|---|---|---|---|
|
country
|
country | string |
The account holder's billing address country (ISO standard). |
|
street
|
street | string |
The account holder's billing address street. |
|
city
|
city | string |
The account holder's billing address city. |
|
state
|
state | string |
The account holder's billing address state (ISO standard). |
|
postal code
|
post_code | string |
The account holder's billing address postal code. |
PaymentsApi.CreditCardInfo
Credit card
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
card_type | string |
The IIN value of the card. |
|
expiration month
|
exp_month | integer |
The expiration month for the card. |
|
expiration year
|
exp_year | integer |
The expiration year for the card. |
|
last four digits
|
last_four | string |
The last 4 digits of primary account number for this card. |
|
cardholder name
|
name | string |
The name of the card holder. |
|
PayPal funding source
|
pay_pal_funding_source | string |
The PayPal payment source used for the transaction. |
PaymentsApi.Disbursement
Disbursement
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the disbursement. |
|
Name
|
name | string |
The disbursement name. |
PaymentsApi.DisbursementCollection
Disbursement collection
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
count | integer |
The number of items available for retrieval into the collection after applying any request parameters. |
|
value
|
value | array of PaymentsApi.Disbursement |
The set of items included in the response. This may be a subset of the items in the collection. |
PaymentsApi.FraudResult
Fraud
| Name | Path | Type | Description |
|---|---|---|---|
|
result code
|
result_code | string |
The overall result of the premium fraud validation (for Premium Fraud Service). |
|
risk score
|
risk_score | integer |
The fraud risk score for the transaction (for Premium Fraud Service). |
|
risk threshold
|
risk_threshold | integer |
The fraud threshold that was set by the client at the time of the transaction (for Premium Fraud Service). |
|
anonymous proxy result
|
anonymous_proxy_result | string |
The result of the anonymous proxy validation (for Premium Fraud Service). |
|
bin and IP country result
|
bin_and_ip_country_result | string |
The result of the bin origination country compared to the origination country of the IP (for Premium Fraud Service). |
|
high risk country result
|
high_risk_country_result | string |
The result of the high risk country validation (for Premium Fraud Service). |
|
velocity result
|
velocity_result | string |
The result of the velocity validation. |
PaymentsApi.GatewayResult
Gateway
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
The message provided by the gateway that processed the transaction. |
PaymentsApi.RelatedTransaction
Related transaction
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier of the related transaction. |
|
transaction Type
|
transaction_type | string |
The transaction type of the related transaction. |
PaymentsApi.Transaction
Transaction
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The system record ID of the transaction. |
|
Currency
|
currency | string |
The 3 char ISO4217 currency code used for the transaction. |
|
Amount
|
amount | integer |
The transaction gross amount (measured in cents). |
|
Additional fee
|
additional_fee | integer |
The additional fee for the transaction (measured in cents). |
|
Application fee
|
application_fee | integer |
The application fee for the transaction (measured in cents). |
|
Total fees
|
total_fees | integer |
The total fees for the transaction (measured in cents). |
|
Net amount
|
net_amount | integer |
The transaction net amount after fees (measured in cents). |
|
Transaction date
|
transaction_date | string |
The transaction date and time. |
|
Transaction type
|
transaction_type | string |
The transaction type. |
|
Comment
|
comment | string |
The comment on the transaction. |
|
Application
|
application | string |
The application that created the transaction. |
|
Terminal type
|
terminal_type | string |
The type of terminal used (for card present transactions). |
|
Donor IP address
|
donor_ip_address | string |
The IP address where the transaction originated. |
|
Email address
|
email_address | string |
The account holder's email address. |
|
Phone number
|
phone_number | string |
The account holder's phone number. |
|
Account type
|
account_type | string |
The type of account of this transaction (for direct debit transactions). |
|
Routing number
|
routing_number | string |
The routing number for the transaction. |
|
Check number
|
check_number | string |
The check number for the transaction. |
|
credit_card
|
credit_card | PaymentsApi.CreditCardInfo |
Credit card |
|
billing_info
|
billing_info | PaymentsApi.BillingInfo |
Billing info |
|
PayPal reference ID
|
pay_pal_reference_id | string |
A reference number from PayPal for the transaction. |
|
Reference transaction ID
|
reference_transaction_id | string |
The unique identifier of the original transaction associated with a refund or dispute. |
|
Token
|
token | string |
The stored token. Available only on creation of the transaction record. |
|
Gateway result code
|
authorization_code | string |
The authorization code for the transaction. |
|
fraud_result
|
fraud_result | PaymentsApi.FraudResult |
Fraud |
|
Pending date
|
pending_date | string |
The date by which decision could be made for the transaction. It will be approved or declined. |
|
Transaction category
|
transaction_category | string |
The category for this transaction (ex: "donation"). |
|
Is live?
|
is_live | boolean |
Is a live transaction? |
|
State
|
state | string |
The current processing state of the transaction. |
|
Disbursement status
|
disbursement_status | string |
The disbursement status of this transaction. |
|
related_transactions
|
related_transactions | array of PaymentsApi.RelatedTransaction | |
|
gateway_result
|
gateway_result | PaymentsApi.GatewayResult |
Gateway |
PaymentsApi.TransactionCollection
Transaction collection
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
count | integer |
The number of items available for retrieval into the collection after applying any request parameters. |
|
value
|
value | array of PaymentsApi.Transaction |
The set of items included in the response. This may be a subset of the items in the collection. |