Skip to main content
POST
Create Onramp
You can create an onramp request with either mobile money or bank checkout to convert fiat to crypto.

Which country the payment is collected in

Most currencies belong to one country, so currency is enough. XOF and XAF are shared by several countries (XOF is used in Senegal, Côte d’Ivoire, Benin, Burkina Faso, Mali, Niger and Togo), so the country is worked out in this order:
  1. country, if you send it. An ISO-2 code such as SN. It must be a country that uses currency and must match the country of the phone number, otherwise the request is rejected with a 400.
  2. The phone number. A +221 number paying in XOF is collected in Senegal, a +225 number in Côte d’Ivoire.
  3. The currency’s default country, when there is no phone number to go by.
You don’t need to send country, because the phone number already decides. Send it when you want the request rejected if the number is not from the country you expect.
Senegal, XOF

Authorizations

Authorization
string
header
required

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

Body

application/json
fiatAmount
number
required

Fiat amount

currency
string
required

The currency of the wallet

Example:

"KES"

chain
enum<string>
required

Chain

Available options:
ETHEREUM,
CELO,
AVALANCHE,
POLYGON,
ARBITRUM,
OPTIMISM,
BINANCE,
STELLAR,
TRON,
FUSE,
LIGHTNING,
SOLANA,
PROVENANCE,
CARDANO,
HEDERA,
BASE,
LISK,
VICTION,
SCROLL
token
enum<string>
required

Stable Coin

Available options:
CUSD,
USDC,
USDT,
USDT0,
SAT,
BTC,
HASH,
FUSE,
HBAR,
USDGLO,
CKES,
CGHS,
MSAT,
XLM,
ADA
receiverAddress
string
required

Receiver address

referenceId
string
required

Reference ID

mobileMoney
object

Mobile Money details

bankCheckout
object

Bank Checkout details

callbackUrl
string

Webhook URL for the terminal status. Falls back to your default webhook URL.

rateId
string

Rate ID

fiatWalletId
string

Links this transaction to a fiat wallet for currency resolution. No fiat is debited.

Response

success
boolean
Example:

true

message
string
Example:

"Request has been successfully created"

data
object