ADadyen
Payments

Get the result of a payment session

Changed on

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

get/sessions/{sessionId}

Request

  • Base URL
    https://checkout-test.adyen.com/v69
  • URL
    https://checkout-test.adyen.com/v69/sessions/{sessionId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

sessionIdstring required

A unique identifier of the session.

Query parameters

sessionResultstring required

The sessionResult value from the Drop-in or Component.

Response

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.

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.

status'active' | 'canceled' | 'completed' | 'expired' | 'paymentPending' | 'refused'

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.

Changes

  • v69deba31ec2266Revision changes
    • warning

      added the new Pending enum value to the // response property for the response status

    • warning

      added the new Received enum value to the // response property for the response status

  • v698c633de107f4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status