Start a transaction for donations

post/donations

Takes in the donation token generated by the /payments request and uses it to make the donation for the donation account specified in the request.

For more information, see Donations.

Endpoint destination URL

https://checkout-test.adyen.com/v71/donations

Header Parameters

Required

Optional

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

Request Parameters

Required

Optional

Shopper account information for 3D Secure 2.

For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.

Show children

Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values:

notApplicable
thisTransaction
lessThan30Days
from30To60Days
moreThan60Days

Date when the shopper's account was last changed.

Indicator for the length of time since the shopper's account was last updated. Allowed values:

thisTransaction
lessThan30Days
from30To60Days
moreThan60Days

Date when the shopper's account was created.

Indicates the type of account. For example, for a multi-account card product. Allowed values:

notApplicable
credit
debit

Number of attempts the shopper tried to add a card to their account in the last day.

Date the selected delivery address was first used.

Indicator for the length of time since this delivery address was first used. Allowed values:

thisTransaction
lessThan30Days
from30To60Days
moreThan60Days

Shopper's home phone number (including the country code).

Shopper's mobile phone number (including the country code).

Date when the shopper last changed their password.

Indicator when the shopper has changed their password. Allowed values:

notApplicable
thisTransaction
lessThan30Days
from30To60Days
moreThan60Days

Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.

Number of all transactions (successful and abandoned) from this shopper in the past year.

Date this payment method was added to the shopper's account.

Indicator for the length of time since this payment method was added to this shopper's account. Allowed values:

notApplicable
thisTransaction
lessThan30Days
from30To60Days
moreThan60Days

Number of successful purchases in the last six months.

Whether suspicious activity was recorded on this account.

Shopper's work phone number (including the country code).

This field contains additional data, which may be required for a particular payment request.

The additionalData object consists of entries, each of which includes the key and value.

The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).

Show children

Information about your application. For more details, see Building Adyen solutions.

Show children

Data for 3DS authentication.

Show children

The address where to send the invoice.

The billingAddress object is required in the following scenarios. Include all of the fields within this object.

For 3D Secure 2 transactions in all browser-based and mobile implementations.

For cross-border payouts to and from Canada.

Show children

The shopper's browser information.

For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the userAgent and acceptHeader fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.

Show children

The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token.

Possible values:

iOS
Android
Web

Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.

Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.

Max length: 100

The shopper country.

Format: ISO 3166-1 alpha-2 Example: NL or DE

The shopper's date of birth.

Format ISO-8601: YYYY-MM-DD

The date and time the purchased goods should be delivered.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

Example: 2017-07-17T13:42:40.428+01:00

The address where the purchased goods should be delivered.

Show children

Max length: 5000

A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.

Donation account to which the transaction is credited.

The donation campaign ID received in the /donationCampaigns call.

PSP reference of the transaction from which the donation token is generated. Required when donationToken is provided.

Donation token received in the /payments call.

Price and product information about the purchased items, to be included on the invoice sent to the shopper.

This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Riverty, and Zip.

Show children

The merchant account identifier, with which you want to process the transaction.

Additional risk fields for 3D Secure 2.

For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.

Show children

Metadata consists of entries, each of which includes a key and a value. Limits:

Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".
Maximum 20 characters per key.
Maximum 80 characters per value.

Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).

Show children

Max length: 80

Required for the 3D Secure 2 channel Web integration.

Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.

The type and required details of a payment method to use.

Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values:

Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.

Specifies the redirect method (GET or POST) when redirecting back from the issuer.

Specifies the redirect method (GET or POST) when redirecting to the issuer.

The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.

Max length: 8000

The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters.

For web, include the protocol http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: https://your-company.com/checkout?shopperOrder=12xy
For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the Apple Developer documentation. Example: my-app://
For Android, use a custom URL handled by an Activity on your app. You can configure it with an intent filter. Example: my-app://your.package.name

If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.

The URL must not include personally identifiable information (PII), for example name or email address.

The date and time until when the session remains valid, in ISO 8601 format.

For example: 2020-07-18T15:42:40.428+01:00

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.

For 3D Secure 2 transactions, schemes require shopperEmail for all browser-based and mobile implementations.

Max length: 1000

The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

For 3D Secure 2 transactions, schemes require shopperIP for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, contact Support.

Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.

This field has the following possible values:

Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
ContAuth - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.

The combination of a language code and a country code to specify the language to be used in the payment.

The shopper's full name.

Show children

Min length: 3Max length: 256

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

Your reference must not include personally identifiable information (PII), for example name or email address.

The shopper's social security number.

The shopper's telephone number.

Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to Online payments or Classic integration documentation.

Show children

Additional information about the Cardholder’s account provided by the 3DS Requestor.

Show children

Min length: 2Max length: 2

Length of time that the cardholder has had the account with the 3DS Requestor. Allowed values:

01 — No account
02 — Created during this transaction
03 — Less than 30 days
04 — 30–60 days
05 — More than 60 days

Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: YYYYMMDD

Min length: 2Max length: 2

Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Allowed values:

01 — Changed during this transaction
02 — Less than 30 days
03 — 30–60 days
04 — More than 60 days

Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: YYYYMMDD

Min length: 2Max length: 2

Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. Allowed values:

01 — No change
02 — Changed during this transaction
03 — Less than 30 days
04 — 30–60 days
05 — More than 60 days

Date that the cardholder opened the account with the 3DS Requestor. Format: YYYYMMDD

Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.

String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Format: YYYYMMDD

Min length: 2Max length: 2

Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Allowed values:

01 — No account (guest checkout)
02 — During this transaction
03 — Less than 30 days
04 — 30–60 days
05 — More than 60 days

Number of Add Card attempts in the last 24 hours. Max length: 3 characters.

String when the shipping address used for this transaction was first used with the 3DS Requestor. Format: YYYYMMDD

Min length: 2Max length: 2

Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Allowed values:

01 — This transaction
02 — Less than 30 days
03 — 30–60 days
04 — More than 60 days

Min length: 2Max length: 2

Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Allowed values:

01 — Account Name identical to shipping Name
02 — Account Name different to shipping Name

Min length: 2Max length: 2

Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Allowed values:

01 — No suspicious activity has been observed
02 — Suspicious activity has been observed

Max length: 3

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters.

Max length: 3

Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters.

Min length: 2Max length: 2

Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:

01 — Not applicable
02 — Credit
03 — Debit

Required for authentication-only integration. The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.

Required for authentication-only integration. The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.

Min length: 1Max length: 1

Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:

Y — Shipping Address matches Billing Address.
N — Shipping Address does not match Billing Address.

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.

Possibility to specify a preference for receiving a challenge from the issuer. Allowed values:

noPreference
requestNoChallenge
requestChallenge
requestChallengeAsMandate

Display options for the 3D Secure 2 SDK. Optional and only for deviceChannel app.

Show children

The home phone number provided by the Cardholder.

Show children

Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly authentication-only integrations. The mcc is a four-digit code with which the previously given acquirerMerchantID is registered at the scheme.

Required for authentication-only integration. The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.

Optional for a full 3D Secure 2 integration. Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.

The messageVersion value indicating the 3D Secure 2 protocol version.

The mobile phone number provided by the Cardholder.

Show children

URL to where the issuer should send the CRes. Required if you are not using components for channel Web or if you are using classic integration deviceChannel browser.

Value true indicates that the transaction was de-tokenised prior to being received by the ACS.

Indicates the type of payment for which an authentication is requested (message extension)

Min length: 1Max length: 3

Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.

Date after which no further authorisations shall be performed. Format: YYYYMMDD

Max length: 4

Indicates the minimum number of days between authorisations. Maximum length: 4 characters.

The sdkAppID value as received from the 3D Secure 2 SDK.

The sdkEphemPubKey value as received from the 3D Secure 2 SDK.

Show children

The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for deviceChannel set to app. Defaults to 60 minutes.

The sdkReferenceNumber value as received from the 3D Secure 2 SDK.

The sdkTransID value as received from the 3D Secure 2 SDK.

Completion indicator for the device fingerprinting.

Indicates the type of Authentication request.

Information about how the 3DS Requestor authenticated the cardholder before or during the transaction

Show children

Indicates whether a challenge is requested for this transaction. Possible values:

01 — No preference
02 — No challenge requested
03 — Challenge requested (3DS Requestor preference)
04 — Challenge requested (Mandate)
05 — No challenge (transactional risk analysis is already performed)
06 — Data Only

Required for authentication-only integration for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.

Required for authentication-only integration for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.

Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.

Show children

URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.

Min length: 2Max length: 2

Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:

01 — Goods/Service Purchase
03 — Check Acceptance
10 — Account Funding
11 — Quasi-Cash Transaction
28 — Prepaid Activation and Load

Identify the type of the transaction being authenticated.

The whiteListStatus value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.

The work phone number provided by the Cardholder.

Show children

If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.

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.
Show moreShow less
amountobject
Authorised amount in the transaction.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
donationAccountstring
The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been onboarded.
idstring
Your unique resource identifier.
merchantAccountstring
The merchant account identifier, with which you want to process the transaction.
paymentobject
Action to be taken for completing the payment.
Show children Hide children
action
Action to be taken for completing the payment.
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.
amountobject
Authorised amount in the transaction.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
donationTokenstring
Donation Token containing payment details for Adyen Giving.
fraudResultobject
The fraud result properties of the payment.
Show children Hide children
accountScoreinteger
The total fraud score generated by the risk checks.
resultsarray[object]
The result of the individual risk checks.
Show children Hide children
accountScoreinteger
The fraud score generated by the risk check.
checkIdinteger
The ID of the risk check.
namestring
The name of the risk check.
merchantReferencestring
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
orderobject
Contains updated information regarding the order in case order information was provided in the request.
Show children Hide children
amountobject
The initial amount of the order.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
expiresAtstring
The expiry date for the order.
orderDatastring
The encrypted order data.
pspReferencestring
The pspReference that belongs to the order.
referencestring
The merchant reference for the order.
remainingAmountobject
The updated remaining amount.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
paymentMethodobject
Details about the payment method used in the transaction. Only returned if resultCode is Authorised.
Show children Hide children
brandstring
The card brand that the shopper used to pay. Only returned if paymentMethod.type is scheme.
typestring
The paymentMethod.type value used in the request.
pspReferencestring
Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

For payment methods that require a redirect or additional action, you will get this value in the /payments/details response.

refusalReasonstring
If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.

For more information, see Refusal reasons.
refusalReasonCodestring
Code that specifies the refusal reason. For more information, see Authorisation refusal reasons.
resultCodestring
The result of the payment. For more information, see Result codes.

Possible values:

AuthenticationFinished – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.

AuthenticationNotRequired – The transaction does not require 3D Secure authentication. Returned for standalone authentication-only integrations.

Authorised – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.

Cancelled – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.

ChallengeShopper – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.

Error – There was an error when the payment was being processed. The reason is given in the refusalReason field. This is a final state.

IdentifyShopper – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.

PartiallyAuthorised – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.

Pending – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.

PresentToShopper – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.

Received – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.

RedirectShopper – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.

Refused – Indicates the payment was refused. The reason is given in the refusalReason field. This is a final state.

threeDS2ResponseDataobject
Response of the 3D Secure 2 authentication.
Show children Hide children
acsChallengeMandatedstring
acsOperatorIDstring
acsReferenceNumberstring
acsSignedContentstring
acsTransIDstring
acsURLstring
authenticationTypestring
cardHolderInfostring
cavvAlgorithmstring
challengeIndicatorstring
dsReferenceNumberstring
dsTransIDstring
exemptionIndicatorstring
messageVersionstring
riskScorestring
sdkEphemPubKeystring
threeDSServerTransIDstring
transStatusstring
transStatusReasonstring
threeDS2Resultobject
Result of the 3D Secure 2 authentication.
Show children Hide children
authenticationValuestring
The authenticationValue value as defined in the 3D Secure 2 specification.
cavvAlgorithmstring
The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
challengeCancelstring
Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to 3D Secure API reference.
dsTransIDstring
The dsTransID value as defined in the 3D Secure 2 specification.
ecistring
The eci value as defined in the 3D Secure 2 specification.
exemptionIndicatorstring
Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values:

lowValue

secureCorporate

trustedBeneficiary

transactionRiskAnalysis

messageVersionstring
The messageVersion value as defined in the 3D Secure 2 specification.
riskScorestring
Risk score calculated by Cartes Bancaires Directory Server (DS).
threeDSRequestorChallengeIndstring
Indicates whether a challenge is requested for this transaction. Possible values:

01 — No preference

02 — No challenge requested

03 — Challenge requested (3DS Requestor preference)

04 — Challenge requested (Mandate)

05 — No challenge (transactional risk analysis is already performed)

06 — Data Only

threeDSServerTransIDstring
The threeDSServerTransID value as defined in the 3D Secure 2 specification.
timestampstring
The timestamp value of the 3D Secure 2 authentication.
transStatusstring
The transStatus value as defined in the 3D Secure 2 specification.
transStatusReasonstring
Provides information on why the transStatus field has the specified value. For possible values, refer to our docs.
whiteListStatusstring
The whiteListStatus value as defined in the 3D Secure 2 specification.
threeDSPaymentDatastring
When non-empty, contains a value that you must submit to the /payments/details endpoint as paymentData.
referencestring
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
statusstring
The status of the donation transaction.

Possible values:

completed

pending

refused
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
additionalDataobject
Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Start a transaction for donations

Header Parameters

Request Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error