APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
CheckoutDonations

Get a list of donation campaigns.

POST
/donationCampaigns

Queries the available donation campaigns for a donation based on the donation context (like merchant account, currency, and locale). The response contains active donation campaigns.

Authorization

AuthorizationBasic <token>

In: header

Header Parameters

Idempotency-Key?string

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request Body

application/json

currency*string

The three-character ISO currency code.

locale?string

Locale on the shopper interaction device.

merchantAccount*string

Your merchant account identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/donationCampaigns" \  -H "Idempotency-Key: 37ca9c97-d1d1-4c62-89e8-706891a563ed" \  -H "Content-Type: application/json" \  -d '{    "merchantAccount": "YOUR_MERCHANT_ACCOUNT",    "currency": "EUR"  }'
{  "donationCampaigns": [    {      "id": "DONATION_CAMPAIGN_ID",      "campaignName": "DONATION_CAMPAIGN_NAME",      "donation": {        "currency": "EUR",        "type": "fixedAmounts",        "donationType": "fixedAmounts",        "values": [          100,          200,          300        ]      },      "nonprofitName": "NONPROFIT_NAME",      "causeName": "NONPROFIT_CAUSE",      "nonprofitDescription": "NONPROFIT_DESCRIPTION.",      "nonprofitUrl": "NONPROFIT_WEBSITE_URL",      "logoUrl": "NONPROFIT_LOGO_URL",      "bannerUrl": "NONPROFIT_BANNER_URL",      "termsAndConditionsUrl": "NONPROFIT_TERMS_AND_CONDITIONS_URL"    },    {      "id": "DONATION_CAMPAIGN_ID",      "campaignName": "DONATION_CAMPAIGN_NAME",      "donation": {        "currency": "EUR",        "type": "roundup",        "donationType": "roundup",        "maxRoundupAmount": 100      },      "nonprofitName": "NONPROFIT_NAME",      "causeName": "NONPROFIT_CAUSE",      "nonprofitDescription": "NONPROFIT_DESCRIPTION.",      "nonprofitUrl": "NONPROFIT_WEBSITE_URL",      "logoUrl": "NONPROFIT_LOGO_URL",      "bannerUrl": "NONPROFIT_BANNER_URL",      "termsAndConditionsUrl": "NONPROFIT_TERMS_AND_CONDITIONS_URL"    }  ]}

Get the result of a payment session GET

Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path.

Make a donation POST

Takes in the donation token generated by the `/payments` request and uses it to make the donation. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).