Skip to main content
POST
Initiate Offramp Payout

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
user_id
string<uuid>
required

The unique identifier of the user

Example:

"5d1aabf5-361e-4470-8b99-51d1ce3ef338"

account_id
string<uuid>
required

The unique identifier of the registered destination account

Example:

"5bc098b7-027f-48a9-9c67-c1666555f5a6"

crypto_deposit_id
string<uuid>
required

The unique identifier of the crypto deposit transaction

Example:

"0750ead5-7f17-4470-8b8f-f13429f7232e"

Response

Payout initiated successfully

id
string<uuid>

Unique identifier for the payout transaction

Example:

"5bb01569-77ac-437a-82ef-a8f1deca18d5"

status
string

Current status of the payout transaction

Example:

"PAYMENT_SUBMITTED"

source_amount
number

Amount of crypto being converted (source amount)

Example:

2

destination_amount
number

Amount of fiat to be received (destination amount)

Example:

115.25

rail_fee
number

Rail fee charged for the transfer

Example:

10

account_details
object