Skip to main content
GET
Retrieve a client session

Authorizations

X-API-KEY
string
header
required

Headers

X-API-VERSION
string
required

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

Example:

"2.4"

Query Parameters

clientToken
string
required

Client token

Response

Successful Response

paymentMethod
Payment Method Options · object
required

Enable certain options associated with the payment methods.

customerId
string

A unique identifier for your customer.

Maximum string length: 255
orderId
string

Your reference for the payment.

Maximum string length: 255
currencyCode
enum<string>

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

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYR,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLP,
CNY,
COP,
COU,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MXV,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWG,
ZWL
amount
integer<int64>

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.

Required range: x >= 0
metadata
Payment Metadata · object

Additional data to be used throughout the payment lifecycle.

customer
Customer Details · object

More information associated with the customer.

order
Order Details · object

More information associated with the order.

orderedAllowedCardNetworks
enum<string>[]

The ordered list of card networks accepted for this client session, as resolved from paymentMethod.orderedAllowedCardNetworks and the default list.

The list of available card networks.

Available options:
AMEX,
DANKORT,
DINERS_CLUB,
DISCOVER,
EFTPOS,
ENROUTE,
ELO,
HIPER,
INTERAC,
JCB,
MAESTRO,
MASTERCARD,
MIR,
PRIVATE_LABEL,
UNIONPAY,
VISA,
CARTES_BANCAIRES,
OTHER
warnings
ClientSessionWarningsAPIResponse · object[]

Warning messages to indicate missing information that are required for payment methods, checkout modules and other features; or when third-party services are unavailable.

approvalMode
enum<string>

The approval mode the client session was created with.

Available options:
AUTO,
MANUAL
currentAttemptId
string<uuid>

ID of the current payment attempt. Only populated for MANUAL approval mode sessions once the checkout has tokenised a payment method; use it with the Payment Attempts API to approve or abort the attempt.