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

Query parameters

clientTokenstringOptional
Client token corresponding to the client session to retrieve

Response

Successful Response
customerIdstringOptional<=256 characters
A unique identifier for your customer.
orderIdstringOptional<=256 characters
Your reference for the payment.
currencyCodeenumOptional

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

amountlongOptional

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 anyOptional
Additional data to be used throughout the payment lifecycle.
customerobjectOptional
More information associated with the customer.
orderobjectOptional
More information associated with the order.
paymentMethodobjectOptional
Enable certain options associated with the payment methods.

Errors