Offramp

Offramp transaction endpoints for converting stablecoins to fiat currency

Get offramp rate

post

Get the current exchange rate for an offramp transaction.

Authorizations
Body
assetstring · enumRequiredPossible values:
countrystringRequired

ISO 3166-1 alpha-2 country code

currencystringOptional

Optional currency code. If not specified, defaults to the country's local currency.

Responses
chevron-right
200

Successfully retrieved offramp rate

application/json
post
/offramp/rate

Get offramp quote

post

Get a real-time quote for an offramp transaction including exchange rate, settlement time, and payment rail information.

Authorizations
Body
amountnumberRequired
countrystring · enumRequiredPossible values:
assetstring · enumRequiredPossible values:
currencystring · enumOptional

Optional currency code. If not specified, defaults to the country's local currency.

Possible values:
channelstring · enumOptional

Optional transfer channel. If not specified, defaults to the country's default channel.

Possible values:
exact_outputbooleanOptionalDefault: false
Responses
chevron-right
200

Successfully retrieved offramp quote

application/json
post
/offramp/quote

Initiate offramp transaction

post

Initiate a stablecoin to fiat transaction.

Authorizations
Body
amountnumberRequired
countrystring · enumRequiredPossible values:
assetstring · enumRequiredPossible values:
currencystring · enumOptional

Optional currency code. If not specified, defaults to the country's local currency.

Possible values:
sender_namestringOptional
exact_outputbooleanOptionalDefault: false
callback_urlstring · uriOptional
referencestring · uuidOptional
channelstring · enumOptional

Optional transfer channel. If not specified, defaults to the country's default channel.

Possible values:
reasonstring · enumOptional

Optional payment reason for compliance purposes

Possible values:
developer_feenumber · max: 100Optional

Optional developer fee percentage (0-100)

Responses
chevron-right
200

Successfully initiated offramp transaction

application/json
post
/offramp/initiate

Last updated