Adyen-for-platform icon

Create and manage donation campaigns

Set up donation campaigns and manage the campaign life cycle in the Customer Area or using API calls.

View source

With Adyen Giving, your users can give shoppers the option to donate to a nonprofit organization when shoppers make a purchase, either online or at the point of sale. To enable this, you set up donation campaigns for account holders, or you build your own UI to let your users self-serve their donation campaigns.

This page describes how to set up and manage donation campaigns. A campaign can be for online payments, for in-person payments, or for both online and in-person payments. To learn how to handle payments with donations after a donation campaign is set up and has started, refer to Online donations or In-person donations.

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, and/or a Terminal API integration with payment terminals or a Standalone solution. The terminals must use terminal software version 1.109 or later. Some terminals or features require software version 1.110 or later.
API credentials To create and manage donation campaigns using API requests, your API credential must have the following role:
  • Management API - Campaign Management read and write
Customer Area roles To create and manage donation campaigns using the Customer Area, you must 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.
Limitations Note the following limitations:
Setup steps Before you begin, make sure that the nonprofit you choose has been onboarded to Adyen. You can also pick one of our pre-approved nonprofits that have already been onboarded.

Donation options

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

However, there are limitations to the supported choices, depending on region and currency and payment method. With in-person payments, there are also limitations with regard to terminal model.

Interaction flow

Donation type

Set up a donation campaign for account holders

To create a donation campaign, you can use your Customer Area or make API calls. Select the tab for the method you want to use.

Manage donation campaigns

To manage the life cycle of account holder donation campaigns, you can use your Customer Area or make API calls. Select the tab for the method you want to use.

Next steps