Get a list of donation campaigns

Get a list of donation campaigns.

POST/donationCampaigns

Use it in a workflow

Add a step and choose the Adyen connector.
Pick the Get a list of donation campaigns action (under Donations).
Fill in the fields below, then reference the result from later steps as {{getAListOfDonationCampaigns.response.data}}.

Request

Headers

Idempotency-Keystring

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

Request body

Enter the body as JSON in the step's Body field.

currencystringrequired

The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/).

labelstring

The label that is assigned to the donation campaign.

localestring

Locale on the shopper interaction device.

merchantAccountstringrequired

Your merchant account identifier.

storestring

Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.

json

{
  "currency": "string",
  "merchantAccount": "string",
  "label": "string",
  "locale": "string",
  "store": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{getAListOfDonationCampaigns.response.data.<field>}}.

donationCampaignsarray<object>

List of active donation campaigns for your merchant account.

amountsobject2 fields

bannerUrlstring

The URL for the banner of the nonprofit or campaign.

campaignNamestring

The name of the donation campaign..

causeNamestring

The cause of the nonprofit.

donationobject5 fields

idstring

The unique campaign ID of the donation campaign.

logoUrlstring

The URL for the logo of the nonprofit.

nonprofitDescriptionstring

The description of the nonprofit.

nonprofitNamestring

The name of the nonprofit organization that receives the donation.

nonprofitUrlstring

The website URL of the nonprofit.

termsAndConditionsUrlstring

The URL of the terms and conditions page of the nonprofit and the campaign.

json

{
  "donationCampaigns": [
    {
      "amounts": {
        "currency": "string",
        "values": [
          0
        ]
      },
      "bannerUrl": "string",
      "campaignName": "string",
      "causeName": "string",
      "donation": {
        "currency": "string",
        "type": "string",
        "donationType": "string",
        "maxRoundupAmount": 0,
        "values": [
          0
        ]
      },
      "id": "string",
      "logoUrl": "string",
      "nonprofitDescription": "string",
      "nonprofitName": "string",
      "nonprofitUrl": "string",
      "termsAndConditionsUrl": "string"
    }
  ]
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Was this page helpful?