Skip to main content
POST
Create Offramp Session
This endpoint needs a server API key. In production, access is enabled per project; contact Crossmint to enable it.

Authorizations

X-API-KEY
string
header
required

API key required for authentication

Body

application/json
payer
object
required
receiptEmail
string<email>
required

Where the withdrawal receipt is sent. A reused session keeps the address it was created with.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
userLocator
string
required

The user who withdraws, as userId:<id>. Email and phone locators are refused.

Minimum string length: 1

Response

The session. The same open session is returned for the same user and wallet until it is used or expires.

clientSecret
string
required

The session token. Pass it to the component as credentials.clientSecret.

expiresAt
string<date-time>
required

When the session stops accepting new withdrawals, in ISO 8601 format. Status tracking continues for 24 hours.

Example:

"2024-01-15T10:30:00.000Z"

sessionId
string
required

The session id. Pass it to the component as credentials.sessionId.