Adyen-for-platform icon

Online donations using Adyen Giving

Enable your users to accept online donations from shoppers using Adyen Giving.

Read more

Giving logo Learn about Adyen Giving on your payment terminals.

With Adyen Giving, your users can give shoppers the option to donate to a nonprofit organization when shoppers make an online purchase. To enable this, you set up donation campaigns for account holder resources.

When a campaign has been started and a shopper chooses to donate, the donation is processed as a separate transaction. Adyen covers all fees and the donation amount is transferred to the nonprofit in full. This means you can split amounts and fees on the original transaction, but not on the donation transaction.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Requirement Description
Integration type Adyen for Platforms with a platform model, with an API only online payments integration using Checkout API v67 or later.
Customer Area roles Make sure that you have the following roles:
  • Donation campaigns viewer: to view donation campaigns and access campaign insights.
  • Donation campaigns manager: to create, start, edit, and end donation campaigns and access campaign insights.
Webhooks Subscribe to the Adyen Giving merchant webhook.
Limitations Note the following limitations:
Setup steps Before you begin, make sure that the nonprofit you choose has been onboarded to Adyen, or pick one of our pre-approved nonprofits that have already been onboarded.

How it works

To enable your users to accept donations at checkout:

  1. Choose a nonprofit.

  2. Set up an account holder donation campaign in your Customer Area, under Giving > Campaigns.
    You need to select:

    • The account holders that you want to make the campaign available to.
    • The nonprofit.
    • The stores and donation settings.

  3. Make sure that your integration can show the active campaign in your checkout, and make a request for the amount that the shopper wants to donate. See Online payments flow.

  4. Make sure you have a way to show the nonprofit's terms and conditions.

  5. To inform shoppers about their donation, make sure that you can process Giving webhook messages.

  6. Start the campaign from the Campaigns overview in your Customer Area.

Donation settings

With our Giving integration, you have the flexibility to choose a combination of donation type and donation moment.

However, there are limitations to the supported choices, depending on region and currency and payment method.

Donation type

In your donation campaign you can configure the following donation types:

  • Fixed amounts: up to three fixed amounts to present to shoppers when they make a payment. Your checkout should provide a selection mechanism, such as donation buttons for these amounts.
  • Round up: allow shoppers to donate by rounding up the transaction amount of their purchase. Your checkout should show a round-up checkbox. We recommend rounding up to the nearest whole amount.

Donation moment

Your integration can present the option to donate at different moments in your checkout flow:

  • Pre-checkout: the shopper can review the total transaction amount that includes the donation before completing their payment.
  • Post-checkout: the shopper can contribute to your donation campaign after completing their payment. This gives you flexibility to align Giving with your existing checkout process.

Set up a donation campaign for account holders

The Campaigns user interface in the Customer Area guides you through setting up a donation campaign, and shows example screens. The main steps to create an Adyen Giving donation campaign for your account holders are as follows:

  1. In your Customer Area, go to Giving > Campaigns.

  2. Select Create new campaign > For account holders.

  3. Add the account holders to the campaign, one by one or as a group:

    • One by one: select Search accounts, select your balance platform, and search by account holder ID or reference, legal entity ID or name, or email address. Then select Add in the tile of the individual account holder.
    • Group: select Submit a list of accounts, select your balance platform, enter a comma-separated list of account holder IDs, and select Add.

    The UI will inform you if an account holder has already been added or cannot be found on the selected balance platform.

  4. Select the campaign details:

    • The nonprofit.
    • Either a specific cause, or "General fundraising".
    • The sales channel: online payments (ecommerce), in-person payments (point of sale), or both.

  5. If you selected online payments, first select the stores that the campaign applies to.
    Then select the donation type. When you choose fixed amounts and enter the amounts in your default currency, we automatically add equivalent amounts in other currencies if necessary for the selected stores.

  6. If you selected in-person payments, first select the stores that the campaign applies to.
    Then refer to in-person donation settings, and select:

    • The one-step or two-step interaction flow.
    • Timeouts for the donation prompt and the payment screen.
    • The text to show on the donation screen on the terminal: the name of the nonprofit or the cause you selected.
    • The donation type. When you choose fixed amounts and enter the amounts in your default currency, we automatically add equivalent amounts in other currencies if necessary for the selected stores.

  7. Review the summary. When everything is correct, select Create campaign.

The campaign is now set up, but not active yet.

When you are ready to activate the campaign:

  1. In your Customer Area, go to Giving > Campaigns.
  2. Find the tile for the campaign, and select Start.

Online payments flow

The donation flow depends on the donation moment:

Get details of your active donation campaigns

Depending on the donation moment that you choose, get the details of your active donation campaigns at either moment:

  • When a shopper proceeds to pay for their original transaction with a payment method that supports donations.
  • When a shopper completes their original transaction with a payment method that supports donations, and the /payments or /payments/details (for iDEAL payments) response includes the donationToken field.

When you make a request to get your active donation campaigns, the response you receive depends on your donation type:

Present the option to donate

Make a donation

Depending on the donation moment for the campaign, you make a donation request at either time:

  • Pre-checkout donation: you first make a /payments request. If the payment is authorized, and the /payments or /payments/details (for iDEAL payments) response includes the donationToken field, you make a donation request.
  • Post-checkout donation: you present the option to donate after the shopper completes the payment for their original transaction, you make a donation request and use the donationToken you received in the /payments or /payments/details (for iDEAL payments) response.

Get the donation outcome

You get the outcome of each donation in a webhook message. For cards, you can show the shopper if their donation is successful after you get the webhook message. For iDEAL, you get the webhook event a day or more later. You can send the outcome to the shopper using email or mobile messaging.

To receive these webhook messages, enable the Adyen Giving merchant webhook, which includes eventCode: DONATION.

For a successful donation, the event contains:

  • success: true.
  • originalReference: use this value to associate the donation with the shopper's original transaction.

Test and go live

Before going live with your integration, use our test cards to test your integration.

See also