Verify a payment result

post/payments/result

deprecated.since.replace

Verifies the payment result using the payload returned from the Checkout SDK.

For more information, refer to How it works.

Endpoint destination URL

https://checkout-test.adyen.com/v68/payments/result

Header Parameters

Required

Optional

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

Request Parameters

Required

Optional

Max length: 40000

Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.

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
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.
fraudResultobject
The fraud result properties of the payment.
Show children Hide children
accountScoreinteger
The total fraud score generated by the risk checks.
resultsarray[FraudCheckResultWrapper]
The result of the individual risk checks.
Show children Hide children
FraudCheckResultobject
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
A unique value that you provided in the initial /paymentSession request as a reference field.
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.
paymentMethodstring
The payment method used in the transaction.
pspReferencestring
Adyen's 16-character 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.

serviceErrorobject
The type of the error.
Show children Hide children
errorCodestring
errorTypestring
messagestring
pspReferencestring
shopperLocalestring
The shopperLocale value provided in the payment request.
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.

Verify a payment result

Header Parameters

Request Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error