Get the result of a payment session

get/sessions/{sessionId}

API Version

Returns the status of the payment session with the sessionId and sessionResult specified in the path.

Endpoint destination URL

https://checkout-test.adyen.com/v68/sessions/{sessionId}

Query Parameters

Required

Optional

The sessionResult value from the Drop-in or Component.

Path Parameters

Required

Optional

A unique identifier of the session.

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.
additionalDataobject
Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to Developers > Additional data.
idstring
A unique identifier of the session.
paymentsarray[object]
A list of all authorised payments done for this session.
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.
paymentMethodobject
Only returned for resultCode: Authorised. Details about the payment method used in the transaction.
brandstring
The card brand that the shopper used to pay. Only returned if paymentMethod.type is scheme.
typestring
The paymentMethod.type value used in the request.
pspReferencestring
Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request.
resultCodestring
The result of the payment. For more information, see Result codes.

Possible values:

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.

referencestring
The unique reference that you provided in the original /sessions request. This identifies the payment and is used in all communication with you about the payment status.
statusstring
The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates.

Possible values:

completed: the shopper completed the payment, and the payment was authorized.

paymentPending: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop.

refused: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session.

canceled: the shopper canceled the payment.

expired: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.

Get the result of a payment session

HTTP Responses

200 - OK