Skip to main content
POST
Create Off-Ramp Session

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Body

application/json

Details for creating an off-ramp session.

fiatAccountId
string<uuid>
required

Unique identifier for the customer's chosen fiat account.

Example:

"fca6d32f-2f7e-4f7e-b224-8be0b92fa3f1"

Response

Off-Ramp session created successfully.

sessionId
string<uuid>
required

Unique identifier for the created off-ramp session.

customerId
string<uuid>
required

Unique identifier for the customer associated with the session.

createdAt
string<date-time>
required

Date and time the off-ramp session was created.

toCurrency
string
required

The target fiat currency for every off-ramp transaction performed with the created session.

paymentMethodType
string
required

The fiat payment method through which the transactions will be performed.

fiatAccountId
string<uuid>
required

Unique identifier for the customer's chosen fiat account.

depositAddresses
object[]
required

A list containing cryptocurrency deposit addresses for supported blockchains.

transactions
object[]

A list containing every transaction that has been either started or completed through this session. On creation, will always be empty.