API Questions about Checkout

Note: The full requirements of PCI 4.0 were enforced March 31, 2025. Your organization has its own PCI audit date to comply with those requirements. To ensure your organization is ready, update all of your payment forms before your PCI audit date. To ensure Blackbaud's compliance before Blackbaud's audit, we ran an Auto-Compliance Migration Script from May 1-16th to enforce updated payment processing. The script updated all unchanged forms with the checkout modal, potentially causing layout and processing changes. This script cannot update API forms, which you must manually update. See Auto Migration FAQs.

If you currently use APIs for your forms, then by March 2025, you must update certain methods to use new APIs that pass tokens to meet PCI v4 standards. Forms that use the APIs of donate, addGift, and offlineOrganizationGift will work until March 2025, but you should make plans to identify your active forms and understand the updates you must make.

The new methods below use transaction tokens to handle payment information, and are only compatible with transactions in the new checkout to meet PCI v4 requirements for credit and debit card transactions

NOTICE: Until March 2025, the previous and new APIs listed below will continue to work concurrently. After March 2025, the previous methods will be deprecated.

NEW methodPREVIOUS method
donateCheckout - See donateCheckout.donate
offlineOrganizationGiftCheckout - See offlineOrganizationGiftCheckout.offlineOrganizationGift

See the Luminate Online API Changelog for full details.

The following new methods verify your form:

  • validateDonateCheckout validates whether the payload passing in donateCheckout is valid or not.

  • validateProcessRegistrationvalidates whether the payload passing in processRegistration is valid or not.

  • validateAddGiftCheckout validates whether the payload passing in AddGiftCheckout is valid or not.

  • validateOfflineOrganizationGiftCheckout validates whether the payload passing in OfflineOrganizationGiftCheckout is valid or not.

Updated API methods

  • addGiftCheckout is supported for all payment types. If you use addGift for offline payments, the addGift API will continue to operate along with our new addGiftCheckout API until March, when only the addGiftCheckout API method will remain.

  • Both processRegistration and refundTransaction were not replaced so as to minimize impact. However, changes were made to their logic and behavior. The new behavior reviews whether a transaction token is passed in the payload instead of card credentials. Until March 2025, if the transaction token is not passed in the payload, then these APIs revert to reviewing the card credentials passed within the payload and behave as the APIs do today. After March 2025, the APIs will only operate using transaction token data. The APIs were also updated to handle any transaction type supported in Luminate Online, including checkout transactions. In a future release, ProcessRegistration will handle PayPal payment methods (and other payment methods), so processRegistrationPaypal will no longer be needed.

  • getTeamRaiserConfig no longer returns a transaction token or payment information.

See our Overview of Checkout API for information on the Luminate API updates.

See our Integration Guide for steps to connect Luminate Online forms with Blackbaud Merchant Services.

Note: startDonationis unchanged.