Skip to main content
POST
POST /sdk/session exchanges your merchant private API key for a short-lived JWT clientToken with a 30-minute TTL. Pass the clientToken to the browser to initialize new TheriusSDK({ clientToken }). Your private key never reaches the browser — it stays on your server where it belongs.
Call this endpoint from your server only. Never call it from browser JavaScript or expose your private API key to the client side.
The request body is entirely optional — call it with no body for a bare clientToken. Set country (required as soon as you also set amount, currency, or orderCode) to bind the session and get back a sessionId. See the parameters and response panels above for the full field list.
The clientToken embeds an HMAC-SHA256 hash of your public key. Your raw private key is never present in the token payload and never reaches the browser.
See Session Bootstrap in the JS SDK tab for how to use the clientToken on the client side.

Authorizations

Authorization
string
header
required

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Body

application/json
country
string

ISO 3166-1 alpha-2 code of the shopper country. Optional for a bare clientToken; required if you also set amount, currency, or orderCode (those create a bound checkout session).

amount
integer

Locked amount in minor units. Omit to let the browser SDK manage the amount.

currency
string

Locked ISO 4217 currency. Omit to let the browser SDK manage it.

installments
integer

Number of installments to offer. Defaults to 1.

orderCode
string

Your order reference to attach to the resulting payment.

customerId
string

Your shopper identifier - enables saved-card retrieval and the save-card checkbox for this session.

paymentCode
string

Pre-assigned Therius payment code, if you allocate them yourself.

checkoutConfigId
string

UUID of a Checkout Builder configuration to bind to this session.

cardOnFile
object

Declares this session's checkout starts a stored-credential mandate (e.g. {"type": "recurring"} for a merchant-managed subscription you bill against yourself later). Requires customerId. When set, the Checkout Widget shows a fixed "card will be saved" disclosure instead of the optional save-card checkbox, and the server forces tokenization + this stored-credential tagging on the resulting charge regardless of what the browser sends. Omit for a plain checkout that just follows the Checkout Builder's save-card setting.

billingAddress
object

The payer's billing address, if you already know it. The Checkout Widget does not ask the shopper for fields you supply here, and a purchase that carries no address of its own is filled in from it. Boleto requires an address to register the voucher.

deliveryAddress
object

Shipping address, same shape as billingAddress. Filled into a purchase that carries none of its own. Requires country.

shopper
object

The payer's data, when you already know it. The Checkout Widget prefills (or, when the merchant chose 'Required, hidden if in session', skips) the matching fields and a purchase fills what it left blank from it. Defaults, not locks. Requires country.

lineItems
object[]

Locks the order's line items for this session. A purchase made with the session token uses these and ignores any lineItems in the purchase call.

commercialData
object

Locks the Level 2/3 card data for this session. A purchase made with the session token always uses it and ignores any commercialData in the purchase call, because that call can come from the browser. Requires country.

Response

200 - application/json

SDK session token

clientToken
string

Short-lived JWT for the browser SDK. Pass as Bearer to the SDK endpoints.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

expiresIn
integer

Token lifetime in seconds.

Example:

1800

defaultCheckoutConfigId
string

The merchant default Checkout Builder config, when no checkoutConfigId was supplied.

sessionId
string

Checkout session ID - present when country created a session.

country
string

Echoed session country.

amount
integer

Echoed locked amount.

currency
string

Echoed locked currency.

cardOnFile
object

Echoed stored-credential intent, present only when the request set cardOnFile.

sdkIntegrity
string

SRI hash of the latest SDK bundle served at GET /sdk/js, when available. Prefer the immutable release in sdk.

sdk
object

The current immutable SDK release. Render url and integrity into the page script tag (with crossorigin="anonymous") on every page render; the URL always serves exactly the bytes the hash describes. Absent when no release is available, in which case use GET /sdk/js without integrity.