Skip to main content
POST
Generate Checkout Token (Platform)

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Body

application/json

Token generation request for Inline Checkout.

Notes Amount and currency are merchant-controlled for Inline Checkout. They are provided by the initiator backend when requesting the token and stored server-side keyed by the checkout nonce.

user_id
string<uuid>
required

Payer (end-user) UUID.

amount
number
required

Payment amount (canonical).

Required range: x <= 100000
currency
string
default:USD

Payment currency code (canonical).

Required string length: 3 - 10

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data
CheckoutTokenResponse · object | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400