Skip to main content
POST
Get Onramp Exchange rate
An integrator can use this endpoint to get the exchange rate between two currencies for onramp transactions.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
from
string
required

The fiat currency the customer pays in.

Example:

"KES"

to
enum<string>
required

The stablecoin to deliver.

Available options:
CUSD,
USDC,
USDT,
USDGLO,
CKES,
CGHS,
MSAT,
ADA
Example:

"USDT"

fiatAmount
number
required

How much to convert. Holds the fiat amount by default; if you set source to crypto it holds the crypto amount instead.

Example:

1000

source
enum<string>

Which currency fiatAmount holds. Defaults to fiat, set crypto to pass a crypto amount.

Available options:
fiat,
crypto
Example:

"fiat"

chain
enum<string>

The chain the crypto is delivered on. Send it for an onramp that will use hosted checkout: the quote then includes the network fee for that chain and a hosted block with the exact amount the customer receives. Ignored for other onramps.

Available options:
ETHEREUM,
CELO,
AVALANCHE,
POLYGON,
ARBITRUM,
OPTIMISM,
BINANCE,
STELLAR,
TRON,
FUSE,
LIGHTNING,
SOLANA,
PROVENANCE,
CARDANO,
HEDERA,
BASE,
LISK,
VICTION,
SCROLL
Example:

"CELO"

hostedCheckout
boolean

Quote for hosted checkout (or not) explicitly, as on the onramp request. When omitted with a chain, hosted checkout is assumed where your account uses it for this currency.

Response

success
boolean
Example:

true

message
string
Example:

"Available exchange rate."

data
object