Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Body

application/json
vendor_data
string
required

Your internal identifier for the end user this token is scoped to. Enforced as the subject identity of every transaction submitted with the token.

Example:

"user-042"

ttl_seconds
integer
default:900

Token lifetime in seconds. Defaults to 900 (15 minutes); maximum 86400 (24 hours).

Required range: x <= 86400
max_uses
integer | null

Maximum number of successful submissions allowed with this token. Omit or null for unlimited uses within the TTL.

Response

The minted token. Hand sdk_token to your app; it authenticates the device-facing /v1/transactions/ endpoints via the X-Transaction-Token header until expires_at.

sdk_token
string

The scoped transaction token to pass to the SDK.

expires_at
string<date-time>

When the token stops being accepted.