Activate or end a donation campaign

post/companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}

Starts or stops the donation campaign specified in the path, by providing a path parameter. Use the path parameter activate to start an inactive campaign, or end to stop an active campaign. Other status transitions are not allowed.

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

Management API—Campaign Management read and write

Endpoint destination URL

https://management-test.adyen.com/v3/companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}

Path Parameters

Required

Optional

The desired status change. Possible values: activate or end.

The unique identifier of the donation campaign to activate or end.

The unique identifier of the company account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
accountHolderIdsarray[string]
The unique identifiers of the account holders associated with the donation campaign.
activatedAtstring
The date and time when the campaign started, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00
endedAtstring
The date and time when the campaign stopped, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00.
idstring
The unique identifier of the donation campaign. This value is generated by Adyen.
inPersonobject
The settings for in-person donations collected as part of the campaign.
amountsarray[object]
The currency and fixed amounts for donations. We automatically add calculated amounts in other currencies for participating stores that use a different currency than the default.
amountsarray[integer]
The donation amounts in minor units. The list must contain at least one amount and no more than three amounts.
currencyCodestring
The three-character ISO currency code.
defaultCurrencystring
The currency that was used in the request to set fixed donation amounts. Format: three-character ISO currency code.
displayTextFieldstring
The text shown on the payment terminal, asking the shopper for a donation.
donationFlowstring
The interaction flow for in-person donations: complete payment for the purchase and the donation in one go, or separately.
donationTypestring
The type of donation to collect from the shopper. Possible values:

roundup: Round up the transaction amount.

fixedAmounts: Choose a fixed amount.

fixedAmountsRoundup: Round up, or choose a fixed amount.

merchantAccountsarray[string]
The merchant accounts for this sales channel that are associated with the donation campaign.
presentCardTimeoutMsinteger
The time, in milliseconds, that the terminal waits for the shopper to present their card.
promptTimeoutMsinteger
The time, in milliseconds, that the terminal waits for the shopper to respond to the text asking for a donation.
storeIdsarray[string]
The Adyen-generated unique identifiers of stores for this sales channel that are associated with the donation campaign.
namestring
The name of the donation campaign.
nonprofitCauseobject
The nonprofit cause that the campaign supports.
bannerUrlstring
The URL to the banner showing the cause that the nonprofit organization supports.
causeIdstring
The unique identifier of the nonprofit cause. This value is generated by Adyen.
descriptionstring
The description of the cause that the nonprofit supports.
globalWebsiteUrlstring
The URL to the website of the nonprofit organization.
goalsarray[string]
The United Nations Sustainable Development Goals (UN SDGs) supported by the nonprofit organization, specified in the format unsdg_<number>, where the number is the number of the UN SDG. For example, unsdg_1.
logoUrlstring
The URL to the logo of the nonprofit organization.
nonprofitNamestring
The name of the nonprofit organization.
termsAndConditionsUrlstring
The URL to the terms and conditions of the nonprofit organization.
onlineobject
The settings for online donations collected as part of the campaign.
amountsarray[object]
The currency and fixed amounts for donations. We automatically add calculated amounts in other currencies for participating stores that use a different currency than the default.
amountsarray[integer]
The donation amounts in minor units. The list must contain at least one amount and no more than three amounts.
currencyCodestring
The three-character ISO currency code.
defaultCurrencystring
The currency that was used in the request to set fixed donation amounts. Format: three-character ISO currency code.
donationTypestring
The type of donation to collect from the shopper. Possible values:

roundup: Round up the transaction amount.

fixedAmounts: Choose a fixed amount.

fixedAmountsRoundup: Round up, or choose a fixed amount.

merchantAccountsarray[string]
The merchant accounts for this sales channel that are associated with the donation campaign.
storeIdsarray[string]
The Adyen-generated unique identifiers of stores for this sales channel that are associated with the donation campaign.
statusstring
The current status of the donation campaign.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Activate or end a donation campaign

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error