Giving for Web Component

Add Giving Campaign Manager to an existing Components integration.

Our Giving Component shows the Giving donation form to the shopper after finishing their original payment.

If the shopper chooses to make a donation, the donation transaction uses the same payment method that the shopper used to make the original payment.

You can accept donations for fixed amounts, or allow the shopper to round up their transaction amount as a donation.

Requirements

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

Requirement	Description
Integration type	Make sure that you have integrated with: Web Components v5.0.0 or later using the Advanced flow Checkout API v67 or later
Customer Area roles	Make sure that you have Donation campaigns manager role.
Webhooks	Subscribe to the following webhook(s): Standard webhooks Adyen Giving merchant webhook
Setup steps	Before you begin: Check if your Customer Area user has the required roles, go to your Customer Area > Settings > Users. If you need additional roles, contact your admin user. Set up components integrations for the payment methods that you want to support. Create and activate a donation campaign.

How it works

After a shopper completes their payment for the original transaction with a payment method that supports donations:

From your server, make a /donationCampaigns request to get the details of your active donation campaigns.
Depending on the donation type of the campaign, you present the option to donate by either:
- Show the shopper a donation form with fixed amounts.
- Show the shopper a round-up checkbox that suggests to round up their payment amount as a donation.
From your server, make a /donations request to make a donation.
Get the outcome from a webhook.

The following diagram shows the Giving Campaign Manager flow after the shopper pays for their original transaction.

Get details of your active donation campaigns

If the shopper's payment is authorized, and the /payments or /payments/details (for iDEAL payments) response includes the donationToken field, get the details of your active donation campaigns.

From your server, make a POST /donationCampaigns request, specifying:

Field name	Required	Description
`merchantAccount`		Your merchant account name.
`currency`		The three-character ISO currency code.
`locale`		The language in which you want to receive the donation campaign details in the response. The default is configured by the nonprofit. Set it to the shopper's language and country code, for example, `en-US`.

The response contains the details of your active donation campaigns. If there is at least one campaign in the response, show Giving in your payment form.

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

Show Giving in your payment form

To show the Giving Component in your payment form:

Create a DOM element for Giving, placing it where you want the form to be rendered:
```
<div id='donation-container'></div>
```

Use the values you received in the /donationCampaigns response to configure the Giving Component. The parameters you need to use depend on your Web Component version:
If you didn't persist a previous instance of the AdyenCheckout object, create a new checkout object.
Use the checkout.create method to create and mount an instance of the Giving Component.

When the shopper selects a donation amount, the Component calls the onDonate event. If state.isValid is true, collect the values passed in state.data which contains the donation amount that the shopper selected.
Pass the state.data to your server.

Make a donation

From your server, make a donation request, using the same payment method as the original transaction.

Get the donation outcome

You get the donation outcome of each donation in a webhook. To receive these webhooks, enable the Adyen Giving merchant webhook, which includes eventCode: DONATION.

For a successful donation, the event contains success: true.

Use the originalReference to associate the donation to the shopper's original transaction.

For cards, you can show the shopper if their donation is successful after you get the webhook. 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.

Test and go live

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