Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Donation campaigns

Create a donation campaign

Creates a new donation campaign, to give shoppers the option to donate to a nonprofit organization when making a payment. A campaign can be for online payments, in-person payments, or both online and in-person payments.

To make this request, your API credential must have the following role:

  • Management API—Campaign Management read and write
post/companies/{companyId}/campaignManagement

Path parameters

companyIdstring required

The unique identifier of the company account.

Request body

accountHolderIdsstring[]

The unique identifiers of the account holders associated with the donation campaign.

namestring required

The name of the donation campaign.

nonprofitCauseIdstring required

The unique identifier of the nonprofit cause that the campaign supports.

Response

OK - the request has succeeded.

accountHolderIdsstring[]

The unique identifiers of the account holders associated with the donation campaign.

activatedAtstring date-time

The date and time when the campaign started, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00

endedAtstring date-time

The date and time when the campaign stopped, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00.

idstring required

The unique identifier of the donation campaign. This value is generated by Adyen.

namestring required

The name of the donation campaign.

status'active' | 'inactive' | 'ended' required