API Questions about Checkout
Luminate Online supports a range of API methods for handling donations, registrations, and gift processing. Below is a summary of the current supported methods and their behavior.
| donateCheckout | ||
What about Luminate Online API integrations?With the introduction of modern checkout, some legacy REST methods were replaced with new methods that use transaction tokens to handle payment information. See the table below.
| NEW method | PREVIOUS method |
|---|---|
donateCheckout - See donateCheckout. | donate |
offlineOrganizationGiftCheckout - See offlineOrganizationGiftCheckout. | offlineOrganizationGift |
See the Luminate Online API Changelog for full details.
The following methods verify your form:
validateDonateCheckoutvalidates whether the payload passing indonateCheckoutis valid or not.validateProcessRegistrationvalidates whether the payload passing inprocessRegistrationis valid or not.validateAddGiftCheckoutvalidates whether the payload passing inAddGiftCheckoutis valid or not.validateOfflineOrganizationGiftCheckoutvalidates whether the payload passing inOfflineOrganizationGiftCheckoutis valid or not.
Updated API methods
addGiftCheckout is supported for all payment types. If you use
addGiftfor offline payments, theaddGiftAPI will continue to operate along with our newaddGiftCheckoutAPI until March, when only theaddGiftCheckoutAPI method will remain.Both
processRegistrationandrefundTransactionwere 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. APIs require transaction token data instead of payment method information. The APIs were also updated to handle any transaction type supported in Luminate Online, including checkout transactions. In a future release,ProcessRegistrationwill handle PayPal payment methods (and other payment methods), soprocessRegistrationPaypalwill no longer be needed.getTeamRaiserConfigno 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.