API ReferenceClient Session API

Update client session

You can update a clients session created earlier with the PATCH /client-session API call.

The only required field for the request is clientToken. Other supported request fields are same as for the POST /client-session API call.

You need to specify only the fields you wish to update. However, if the items that are to be updated are of type array, then you need to provide the complete array along with modified items.

If you wish to update nested fields on the client session, such as the customer emailAddress field, you can pass the customer object with only one field, emailAddress, to update.

If you simply wish to clear the value of the field, pass null as your input.

You can update paymentMethod.vaultOnSuccess field but updating of the paymentMethod.options field through PATCH /client-session is not supported.

The response will contain all the fields of the client session including the ones that were changed.

Headers

X-API-KEYstringRequired
X-API-VERSIONstringRequired

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

Request

This endpoint expects an object.
clientTokenstringOptional

Client token for use in the Primer-JS SDK obtained via POST /client-session API call.

customerIdstringOptional
A unique identifier for your customer.
orderIdstringOptional
Your reference for the order.
currencyCodestringOptional

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

amountlongOptional

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.

metadatamap from strings to anyOptional
Additional data to be used throughout the payment lifecycle. Provide the entire object to update it. Anything provided previously will be overwritten.
customerobjectOptional
More information associated with the customer. Each of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.
orderobjectOptional
More information associated with the order. Each of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.
paymentMethodobjectOptional
Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten.

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