v1
latestOpenAPI 3.1.02026-07-2022194782.1 KBMake a donation
Takes in the donation token generated by the /payments request and uses it to make the donation.
For more information, see Donations.
Headers
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request body
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.
List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.
Example: "allowedPaymentMethods":["ideal","applepay"]
List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.
Example: "blockedPaymentMethods":["ideal","applepay"]
The delay between the authorization and scheduled auto-capture, specified in hours.
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.
The shopper country code.
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
A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
Donation account to which the transaction is credited.
PSP reference of the transaction from which the donation token is generated. Required when donationToken is provided.
Donation token received in the /payments call.
When true and shopperReference is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
When true and shopperReference is provided, the payment details will be tokenized for payouts.
When true and shopperReference is provided, the payment details will be tokenized for recurring payments.
The type of the entity the payment is processed for.
An integer value that is added to the normal fraud score. The value can be either positive or negative.
The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
The merchant account identifier, with which you want to process the transaction.
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorizations.
We strongly recommend you send the merchantOrderReference value to benefit from linking payment requests when authorization retries take place. In addition, we recommend you provide retry.orderAttemptNumber, retry.chainAttemptNumber, and retry.skipRetry values in PaymentRequest.additionalData.
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.
When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.
Date after which no further authorizations shall be performed. Only for 3D Secure 2.
Minimum number of days between authorizations. Only for 3D Secure 2.
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.
The URL to return to in case of a redirection. The format depends on the channel.
- 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.example.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.
We strongly recommend that you use a maximum of 1024 characters.
The URL must not include personally identifiable information (PII), for example name or email address.
The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
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. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the telephoneNumber.
The shopper's IP address. 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).
Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the shopperEmail. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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 authorization 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 authorization (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.
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 text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.
The shopper's social security number.
Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.
The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication.
Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail.
Set to true if the payment should be routed to a trusted MID.
Response
OK - the request has succeeded.
The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been onboarded.
Your unique resource identifier.
The merchant account identifier, with which you want to process the transaction.
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.
The status of the donation transaction.
Possible values:
- completed
- pending
- refused