Donation APIs process online donations and refunds, log offline donations and refunds, and support designated and recurring gift management.
A designated gift is donation made to a focus within the greater mission. For example, a donor to a hospital may want to direct money to the pediatrics or cancer ward. A donor to a school may want to direct funds to music or STEM programs.
Administrators may choose to allow designated giving when designing donation forms. To offer designated giving, you must create designees and, optionally, designation types.
When allowing a single designee you must include the Single Gift Designation data element in your standard donation form. Include the single_designated_id parameter instead of the designated.X parameters in your call. The designated.x parameters, if included, are ignored when a single_designated_id has been assigned.
When allowing multiple designees you must include the Designated Gift Donation Level data element in your standard donation form. To allow a donor to assign specific donation amounts to multiple designees, you may add an Add a designee button that inserts fields for the designee selection, or write in designee information, and amount onto the form. The code for that button should start with an integer and be incremented for each additional designee. That integer identifies which designation is being referenced, and is the X value inserted in parameters such as designated.X.id.
Pre-configured designee information is passed in a pair of parameters: designated.X.id and designated.X.amount.
Write-in designee information is passed in set of three parameters - designated_write_in.X.name, designated_write_in.X.contact, and designated_write_in.X.amount.
Preset amounts, sometimes linked to premiums such as merchandise or memberships, which donors can select when submitting a donation.
Configure industry-standard fraud management settings — such as Card Security Code (CSC) checks and Address Verification Service (AVS) settings — within the Blackbaud Merchant Services Web Portal.
Funds collected outside your Luminate Online payment settings. Examples include credit card payments through third-party processors, cash, and checks. These transactions are not automatically recorded in your database. The offline API methods allow you to record these funds and assign them to a campaign for reporting, acknowledgements, etc. In some cases a recordOnly element must be set to true. You may also grant permissions for a third-party payment service providers to use the addOfflineDonation and refundOfflineDonation API methods to notify Luminate Online of transactions.
Optimized HTML and CSS code to best display your content on different screen sizes such as mobile phones, tablets, and laptops.
Donors see, enter data in, and submit a public form of your own design. Every field on that API form must have an element id to map it to a field on a standard Luminate Online donation form. It is that second form, a "shadow form" which the donor never sees, that maps information to correct fields in your Luminate Online database. Instruct your API call to send information through the correct shadow form by including a form id parameter when recording donations submitted on API forms.
Also known as Recurring Gifts, these donations are a schedule a series of automatic payments. These gifts can be indefinite, toward a total value, or for a defined time period.