ADadyen
Payments

Submit details for a payment

Changed on

Submits details for a payment created using /payments. This step is only needed when no final state has been reached on the /payments request, for example when the shopper was redirected to another page to complete the payment.

post/payments/details

Request

  • Base URL
    https://checkout-test.adyen.com/v69
  • URL
    https://checkout-test.adyen.com/v69/payments/details
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Headers

Idempotency-Keystring

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

Request body

paymentDatastring

Encoded payment data. For authorizing a payment after using 3D Secure 2 Authentication-only:

If you received resultCode: AuthenticationNotRequired in the /payments response, use the threeDSPaymentData from the same response.

If you received resultCode: AuthenticationFinished in the /payments response, use the action.paymentData from the same response.

threeDSAuthenticationOnlyboolean

Change the authenticationOnly indicator originally set in the /payments request. Only needs to be set if you want to modify the value set previously.

Response

OK - the request has succeeded.

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.

donationTokenstring

Donation Token containing payment details for Adyen Giving.

merchantReferencestring

The reference used during the /payments 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.

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.

resultCode'AuthenticationFinished' | 'AuthenticationNotRequired' | 'Authorised' | 'Cancelled' | 'ChallengeShopper' | 'Error' | 'IdentifyShopper' | 'PartiallyAuthorised' | 'Pending' | 'PresentToShopper' | 'Received' | 'RedirectShopper' | 'Refused' | 'Success'

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

The shopperLocale.

threeDSPaymentDatastring

When non-empty, contains a value that you must submit to the /payments/details endpoint as paymentData.

Changes