Blackbaud Checkout supports the following transactions. For information about how to initialize the payment form, see the integration guide.
A credit card transaction where the physical card may not be present. Typically, this is an online transaction.
Blackbaud_OpenPaymentForm() //or Blackbaud_OpenCardNotPresentForm()
Blackbaud_OpenPaymentForm()
//or
Blackbaud_OpenCardNotPresentForm()| Parameter | Type | Description |
|---|---|---|
| amount | Decimal | The amount of the transaction being processed. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| payment_configuration_id | Guid | The ID of the merchant account to process the transaction. For more information, see the Payment configuration list endpoint. |
| Parameter | Type | Description |
|---|---|---|
| billing_address_first_name | String | The first name of the donor. |
| billing_address_last_name | String | The last name of the donor. |
| billing_address_line | String | The street address of the donor's billing address. |
| billing_address_city | String | The city of the donor's billing address. |
| billing_address_state | String | The ISO3166-2 alpha-3 state code of the donor's billing address. |
| billing_address_country | String | The two-character ISO3166 country code of the donor's billing address. |
| billing_address_post_code | String | The postal code of the donor's billing address. |
| billing_address_email | String | The email address of the donor. |
| billing_address_phone | String | The phone number of the donor. |
| cardholder | String | The name of the credit card holder or direct debit account name. |
| card_token | String | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| delayed_capture | Boolean | If the transaction should be flagged for delayed capture. Delayed capture allows up to 7 days for an authorized transaction to be captured before it is automatically voided. Defaults to false. |
| description | String | A description of the transaction to display to the donor. |
| device_partner_code | PartnerCode | The type of partner device used to capture card data. Defaults to none. |
| disable_3_d_s | Boolean | If the transaction should support 3DS. Defaults to false. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| is_email_required | Boolean | If the Checkout payment page should require an email address. Defaults to false. |
| is_name_required | Boolean | If the Checkout payment page should require first and last name. Defaults to false. |
| is_name_visible | Boolean | If the Checkout payment page should display first and last name fields. Defaults to false. |
| is_offline | Boolean | If the gift is back-office without the donor (1) physically present to authenticate and/or (2) present to opt-in to a mandate for CAD ACSS. Defaults to false. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| security_token | String | A unique token that allows the transaction to operate in a privileged context. For more information, see security tokens. |
| transaction_category | String | The category for this transaction (ex: "donation"). Refer the list of transaction category values. |
| use_apple_pay | Boolean | If the Checkout payment page should display the Apple Pay payment option. Defaults to true |
| use_apple_pay_donate_button | Boolean | If the Apple Pay button should display "Donate now with Apple Pay" instead of just "Apple Pay." |
| use_captcha | Boolean | If the Checkout payment page should present the donor with reCAPTCHA validation. Defaults to false. |
A credit card transaction where the physical card is present. Typically, this is used in conjunction with an external reader such as a payment terminal.
Blackbaud_OpenCardPresentForm()
Blackbaud_OpenCardPresentForm()| Parameter | Type | Description |
|---|---|---|
| amount | Decimal | The amount of the transaction being processed. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| payment_configuration_id | Guid | The ID of the merchant account to process the transaction. For more information, see the Payment configuration list endpoint. |
| Parameter | Type | Description |
|---|---|---|
| billing_address_line | String | The street address of the donor's billing address. |
| billing_address_city | String | The city of the donor's billing address. |
| billing_address_state | String | The ISO3166-2 alpha-3 state code of the donor's billing address. |
| billing_address_country | String | The two-character ISO3166 country code of the donor's billing address. |
| billing_address_post_code | String | The postal code of the donor's billing address. |
| billing_address_email | String | The email address of the donor. |
| billing_address_phone | String | The phone number of the donor. |
| cardholder | String | The name of the credit card holder or direct debit account name. |
| card_token | String | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| delayed_capture | Boolean | If the transaction should be flagged for delayed capture. Delayed capture allows up to 7 days for an authorized transaction to be captured before it is automatically voided. Defaults to false. |
| description | String | A description of the transaction to display to the donor. |
| device_partner_code | PartnerCode | The type of partner device used to capture card data. Defaults to none. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| security_token | String | A unique token that allows the transaction to operate in a privileged context. For more information, see security tokens. |
A direct debit transaction.
Blackbaud_OpenDirectDebitForm()
Blackbaud_OpenDirectDebitForm()| Parameter | Type | Description |
|---|---|---|
| amount | Decimal | The amount of the transaction being processed. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| payment_configuration_id | Guid | The ID of the merchant account to process the transaction. For more information, see the Payment configuration list endpoint. |
| Parameter | Type | Description |
|---|---|---|
| billing_address_first_name | String | The first name of the donor. |
| billing_address_last_name | String | The last name of the donor. |
| billing_address_line | String | The street address of the donor's billing address. |
| billing_address_city | String | The city of the donor's billing address. |
| billing_address_state | String | The ISO3166-2 alpha-3 state code of the donor's billing address. |
| billing_address_country | String | The two-character ISO3166 country code of the donor's billing address. |
| billing_address_post_code | String | The postal code of the donor's billing address. |
| billing_address_email | String | The email address of the donor. |
| billing_address_phone | String | The phone number of the donor. |
| cardholder | String | The name of the credit card holder or direct debit account name. |
| description | String | A description of the transaction to display to the donor. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| is_email_required | Boolean | If the Checkout payment page should require an email address. Defaults to false. |
| is_name_required | Boolean | If the Checkout payment page should require first and last name. Defaults to false. |
| is_name_visible | Boolean | If the Checkout payment page should display first and last name fields. Defaults to false. |
| is_offline | Boolean | If the gift is back-office without the donor (1) physically present to authenticate and/or (2) present to opt-in to a mandate for CAD ACSS. Defaults to false. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| use_captcha | Boolean | If the Checkout payment page should present the donor with reCAPTCHA validation. Defaults to false. |
| security_token | String | A unique token that allows the transaction to operate in a privileged context. For more information, see security tokens. |
| transaction_category | String | The category for this transaction (ex: "donation"). Refer the list of transaction category values. |
A transaction to store and tokenize card information.
Blackbaud_OpenStoreCardForm()
Blackbaud_OpenStoreCardForm()| Parameter | Type | Description |
|---|---|---|
| card_token | Guid | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| Parameter | Type | Description |
|---|---|---|
| cardholder | String | The name of the credit card holder or direct debit account name. |
| description | String | A description of the transaction to display to the donor. |
| device_partner_code | PartnerCode | The type of partner device used to capture card data. Defaults to none. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| is_offline | Boolean | If the gift is back-office without the donor (1) physically present to authenticate and/or (2) present to opt-in to a mandate for CAD ACSS. Defaults to false. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| security_token | String | A unique token that allows the transaction to operate in a privileged context. For more information, see security tokens. |
A transaction to update stored card information.
Blackbaud_OpenUpdateCardForm()
Blackbaud_OpenUpdateCardForm()| Parameter | Type | Description |
|---|---|---|
| card_token | Guid | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| Parameter | Type | Description |
|---|---|---|
| cardholder | String | The name of the credit card holder or direct debit account name. |
| description | String | A description of the transaction to display to the donor. |
| device_partner_code | PartnerCode | The type of partner device used to capture card data. Defaults to none. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| is_offline | Boolean | If the gift is back-office without the donor (1) physically present to authenticate and/or (2) present to opt-in to a mandate for CAD ACSS. Defaults to false. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
A transaction to store and tokenize direct debit account information.
Blackbaud_OpenStoreDirectDebitForm()
Blackbaud_OpenStoreDirectDebitForm()| Parameter | Type | Description |
|---|---|---|
| card_token | Guid | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| Parameter | Type | Description |
|---|---|---|
| cardholder | String | The name of the credit card holder or direct debit account name. |
| description | String | A description of the transaction to display to the donor. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
A transaction to update stored direct debit account information.
Blackbaud_OpenUpdateDirectDebitForm()
Blackbaud_OpenUpdateDirectDebitForm()| Parameter | Type | Description |
|---|---|---|
| card_token | Guid | The token to store the donor's card or direct debit information in the BBPS card info vault. |
| key | Guid | The unique key that identifies the organization communicating with BBSP. To view your key, see the Public key endpoint. |
| Parameter | Type | Description |
|---|---|---|
| cardholder | String | The name of the credit card holder or direct debit account name. |
| description | String | A description of the transaction to display to the donor. |
| font_family | String | The font for header text, footer text, and all content. This does not include text in form fields. Supported fonts include roboto, opensans, arial, arialblack, georgia, tahoma, times, helvetica, trebuchet, and verdana. Defaults to roboto. |
| font_color | String | The color of the font when displayed on top of the primary and secondary colors. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| note | String | An internal field to store information about the transaction. |
| primary_color | String | The color of the form buttons, footer, and field highlights. Accepts valid 6-digit hexadecimal colors such as #FF0000. |
| secondary_color | String | The color of the validation error background. Accepts valid 6-digit hexadecimal colors such as #FF0000. |