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
Click to copy

Header Parameters

Idempotency-Keystring

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

Request Parameters

accountInfoobject

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.

additionalDataobject

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.

amountobjectRequired

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

applicationInfoobject

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

authenticationDataobject

Data for 3DS authentication.

billingAddressobject

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.
browserInfoobject

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.

channelstring

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
checkoutAttemptIdstring

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

conversionIdstringDeprecated in version 68

Use checkoutAttemptId instead

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

countryCodestring

The shopper country.

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

dateOfBirthstring

The shopper's date of birth.

Format ISO-8601: YYYY-MM-DD

deliverAtstring

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

deliveryAddressobject

The address where the purchased goods should be delivered.

deviceFingerprintstring
Max length: 5000

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

donationAccountstring

Donation account to which the transaction is credited.

donationOriginalPspReferencestring

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

donationTokenstring

Donation token received in the /payments call.

lineItemsarray[object]

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, and Zip.

merchantAccountstringRequired

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

merchantRiskIndicatorobject

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.

metadataobject

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.
mpiDataobject

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

originstring
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.

paymentMethodRequired

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

recurringProcessingModelstring

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.
redirectFromIssuerMethodstring

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

redirectToIssuerMethodstring

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

referencestringRequired

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.

returnUrlstringRequired
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
sessionValiditystring

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

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

shopperEmailstring

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.

shopperIPstring

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.

shopperInteractionstring

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.
shopperLocalestring

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

shopperNameobject

The shopper's full name.

shopperReferencestring
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.

socialSecurityNumberstring

The shopper's social security number.

telephoneNumberstring

The shopper's telephone number.

threeDS2RequestDataobject

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.

threeDSAuthenticationOnlybooleanDeprecated in version 69

Use authenticationData.authenticationOnly instead.

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
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less