Skip to main content
POST
Get Offramp Quote

Authorizations

x-api-key
string
header
required

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

Body

application/json

Request a quote for offramp transfer. Either amount_in or amount_out must be provided (but not both).

user_id
string<uuid>
required

The unique identifier of the user

Example:

"0d64857d-1052-4252-a95b-c118ee86efa9"

crypto
string
required

The cryptocurrency to convert (e.g., USDC, USDT)

Example:

"USDC"

blockchain
string
required

The blockchain network (e.g., solana, ethereum, polygon)

Example:

"solana"

destination_currency
string
required

The destination fiat currency code (ISO 4217)

Example:

"PHP"

amount_in
number

Amount of crypto to convert (input amount). Either amount_in or amount_out must be provided.

Example:

0.3

amount_out
number

Amount of fiat to receive (output amount). Either amount_in or amount_out must be provided.

Example:

17.87

Response

Quote retrieved successfully

id
string<uuid>

Unique identifier for the quote

Example:

"733bb4d7-9ae3-44f6-b73c-82909bba8352"

amount_in
number

Amount of crypto to convert (input amount)

Example:

0.3

amount_out
number

Amount of fiat to be received (output amount)

Example:

17.87

rail_fee
number

Rail fee charged for the transfer

Example:

10

crypto
string

The cryptocurrency being converted

Example:

"USDC"

blockchain
string

The blockchain network used

Example:

"solana"

destination_currency
string

The destination fiat currency code (ISO 4217)

Example:

"PHP"

carbn_exchange_rate
number

Carbn's exchange rate for the conversion

Example:

59.57

exchange_rate
number

The exchange rate applied for the conversion

Example:

59.46