Creating a client session generates a client token: a temporary key used to initialize Universal Checkout and authenticate it against your account.
Universal Checkout automatically retrieves all the settings from the client session and the Dashboard to configure the payment methods and the checkout experience.
Note:
When creating a Client Session, please make sure to provide currencyCode
, orderId
, and at least one of amount
or lineItems
.
If any of these are not yet available, you can provide them w
hen making the payment request.
POST /client-session
does not have required fields as all fields are not always known when a client session is created.
Use PATCH /client-session
to update the parameters throughout the checkout session.
Client tokens expire after 24 hours.
The amount you would like to charge the customer, in minor units. e.g. for $7, use 700
.
Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use 100
.
If the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts.
A unique identifier for your customer.
Create a client session token with a customerId
to enable the client-side SDK to retrieve and manage your customer’s saved payment methods. A client session token also enables saving payment methods against this customer id.
Additional data to be used throughout the payment lifecycle.
A dictionary of key-value pairs where the values can only be strings or integers.
e.g. {"productId": 1001, "merchantId": "a13bsd62s"}
The 3-letter currency code in ISO 4217 format.
e.g. use USD
for US dollars.
The amount you would like to charge the customer, in minor units. e.g. for $7, use 700
.
Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use 100
.
If the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts.