API reference

Digital wallet configuration

Use digital wallets with Blackbaud Merchant Services to simplify the payment experience for donors, increase conversions by minimizing donation form abandonment, and provide secure payment authorization.

Onboarding

To display Apple Pay, Apple requires you to host a file to validate merchant domains. The integrating application hosts this file at the root of the domain where you launch Blackbaud Checkout.

Host Apple Pay file

  1. Download the zipped folder that contains the Apple Pay file that Blackbaud hosts.

    Download Apple Pay file

  2. Unzip the folder and host the Apple Pay file publicly in the domain where your organization launches its Blackbaud Checkout form. The complete file path should look like [top-level domain]/.well-known/apple-developer-merchantid-domain-association.

  3. Repeat the previous step for any domains or subdomains where Apple Pay should appear. For example, the Apple Pay file path for https://domainexample.com/donation/page.html is https://domainexample.com/.well-known/apple-developer-merchantid-domain-association.

Transaction parameters

Blackbaud Checkout supports the configuration of Apple Pay buttons through the following transaction parameters:

ParameterTypeAvailable forDescription
use_apple_payBooleancard not present transactions Indicates whether to display the Apple Pay button. Defaults to true if Blackbaud Payment Service client is enrolled.
use_apple_pay_donate_buttonBooleancard not present transactions Indicates whether to display "Donate now with Apple Pay" on the Apple Pay button. By default, it only displays "Apple Pay".

Sample usage:

JavaScript 
    var data = {
      'key' : 'cf3cd5cc-43ef-4f89-9170-03c4fc55be61',
      'payment_configuration_id': 'f086c1c9-5512-4386-a9a4-ecc6fe755f64',
      'amount': 10.00,
      'client_app_name': 'Blackbaud Checkout Sample Data',
      'use_apple_pay': 'true',
    };

    Blackbaud_OpenPaymentForm(data);
  
var data = {
  'key' : 'cf3cd5cc-43ef-4f89-9170-03c4fc55be61',
  'payment_configuration_id': 'f086c1c9-5512-4386-a9a4-ecc6fe755f64',
  'amount': 10.00,
  'client_app_name': 'Blackbaud Checkout Sample Data',
  'use_apple_pay': 'true',
};

Blackbaud_OpenPaymentForm(data);

Blackbaud automatically registers Apple Pay configurations within 48 hours when it detects a Checkout form with the Apply Pay option set to true. If the configuration fails or you have questions about the status, post them to the Blackbaud SKY Developer community board.

Tokenization

Blackbaud Checkout does not support tokenization for digital wallets. If a card token is supplied in a transaction request, the Checkout transaction (Create) returns an empty GUID.