Submit details for a payment

post/payments/details

API Version

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.

Endpoint destination URL

https://checkout-test.adyen.com/v67/payments/details

Header Parameters

Required

Optional

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

Request Parameters

Required

Optional

Use this collection to submit the details that were returned as a result of the /payments call.

Max length: 200000

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.

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 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.
action
Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.
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.
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.
accountScoreinteger
The total fraud score generated by the risk checks.
resultsarray[FraudCheckResultWrapper]
The result of the individual risk checks.
FraudCheckResultobject
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 used during the /payments request.
orderobject
Contains updated information regarding the order in case order information was provided in the request.
amountobject
The initial amount of the order.
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.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
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.
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.

shopperLocalestring
The shopperLocale.
threeDS2ResponseDataobject
Response of the 3D Secure 2 authentication.
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.
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).
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.
400 - Bad Request
A problem reading or understanding the request.
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.
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.
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.
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.
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.

Submit details for a payment

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error