Donations

Adyen Giving is our donations feature. It lets your shoppers donate to a nonprofit as part of your payment flow. If the shopper chooses to make a donation, the donation amount is charged to the same payment method that was used for the original transaction. Drop-in handles the donation flow, including showing the donation campaign and processing the donation.

Requirements

In addition to the general Adyen Giving requirements, take into account the following requirements.

How it works

1. The shopper goes to the checkout page.
2. Your server creates a payment session. You do not need to pass any donation-specific parameters in your request to create a payment session.
3. When you create a global configuration object for AdyenCheckout, optionally add a configuration object for donations.
4. Drop-in shows the payment form.
5. The shopper submits the payment on your checkout page.
6. Drop-in handles the payment flow.
7. If the payment is successful, Drop-in checks if you have an active donation campaign in your Adyen Customer Area.
8. If you have an active donation campaign, Drop-in shows the donation form.
9. The shopper chooses to donate or declines.
10. Drop-in handles the donation flow.
11. Get the donation result from the donation.onDonationSuccess callback.
12. Adyen sends a webhook message with the donation outcome.
13. Adyen sends a webhook message with the payment outcome.

Add Giving configuration

When you create a global configuration object for Drop-in, you add configuration for donations to enable the feature.

Event handlers:

Property	Required	Description
onDonationSuccess		Called when the donation is completed or the shopper declines to donate. Receives an object with didDonate: true or false.
onDonationFailure		Called when an error occurs in the donation creation or when a donation fails.

Configuration parameters:

After a successful payment, if you have an active donation campaign configured, Drop-in shows the donation form. By default, the donation form is mounted in the same container as Drop-in.

Drop-in handles the full donation flow, including:

• Showing the donation campaign details (nonprofit name, description, logo, and banner).
• Showing the donation amount options.
• Processing the donation.

Get the donation outcome

After Drop-in finishes the payment flow, you can inform the shopper about the current payment status.

Inform the shopper

Depending on whether the donation was successful, the onDonationSuccess or onDonationFailure event is triggered. From the relevant event, you can get the result object to inform the shopper.

Get the webhook message

You also get the outcome of each donation in a webhook message.

For a successful donation, the event contains:

Test and go live

Before you go live with donations, test your integration to make sure that your nonprofit receives the donations from your shoppers. We recommend to test your integration in the test environment, and live environment. In each environment, test the following:

1. Creating and activating a donation campaign.
2. Making a donation.
3. Getting the donation outcome in the webhook message (Adyen Giving merchant webhook).

Test environment

Create and activate a test donation campaign

1. In your test Customer Area, go to Giving > Campaigns.
2. Create a test campaign using one of our demo nonprofits.
3. Select Start campaign for the campaign you configured to:
   • Activate the campaign.
   • Start receiving the donationToken in the /payments or /payments/details responses.

Make a test donation

After you have started a campaign, verify that the /payments or /payments/details response contains a donationToken.

When you make a /donationCampaigns request, verify that the details returned in the response are correct.

Using your integration, make test donations using our test cards.

Get the test donation outcome

For each test donation that you make, verify that you get a webhook message.

Live environment

Create and activate a live donation campaign

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

   If you do not see Giving section in your Customer Area, reach out to your Adyen contact or our Support Team.

2. Create a campaign for your nonprofit.
3. Select Start campaign for the campaign you configured to:
   • Activate the campaign.
   • Start receiving the donationToken in the /payments or /payments/details responses.

Enable the webhook for the live environment

In your live Customer Area, enable the Adyen Giving merchant webhook.

Make donations for your live campaign

After you have started a campaign, verify that the /payments or /payments/details response contains a donationToken.

When you make a /donationCampaigns request, verify that the details returned in the response are correct.

Using your integration, make a donation to your nonprofit.

Get the donation outcome

You can verify the outcome of the donation by either:

• Getting the webhook message for your donation.
• Finding the donation in a Giving report or dashboard.

Troubleshooting

If an issue occurs with your test donation requests, you can find more details in the API logs.

Test cards for donations

You can use the test card details below to make test donations.

The following test card doesn't require the CVC when entering the card details. You must use this card to test Visa payments.

Test 3D Secure 2 authentication with donations

The following test cards are enrolled in 3D Secure 2.