Onramp

Onramp transaction endpoints for converting fiat currency to stablecoins

Get onramp rate

post

Get the current exchange rate for an onramp 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 onramp rate

application/json
post
/onramp/rate

Get onramp quote

post

Get a real-time quote for an onramp 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
developer_feenumber · max: 100Optional

Optional developer fee percentage (0-100)

Responses
chevron-right
200

Successfully retrieved onramp quote

application/json
post
/onramp/quote

Initiate onramp transaction

post

Initiate a fiat to stablecoin transaction.

Authorizations
Body
amountnumberRequired
countrystring · enumRequiredPossible values:
currencystring · enumOptional

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

Possible values:
assetstring · enumRequiredPossible values:
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 onramp transaction

application/json
post
/onramp/initiate

Last updated