API ReferenceClient Session API

Retrieve a client session

This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.

Headers

X-API-KEYstringRequired
X-API-VERSIONstringRequired

Specifies the version of the API to use. This must be set to 2.4.

Query parameters

clientTokenstringOptional
Client token corresponding to the client session to retrieve

Response

Successful Response
customerIdstring or null<=256 characters
A unique identifier for your customer.
orderIdstring or null<=256 characters
Your reference for the payment.
currencyCodeenum or null

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

amountlong or null

The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the order. If a top-level amount is provided, it would override any calculated amount.

metadatamap from strings to any or null
Additional data to be used throughout the payment lifecycle.
customerobject or null
More information associated with the customer.
orderobject or null
More information associated with the order.
paymentMethodobject or null
Enable certain options associated with the payment methods.

Errors