Skip to main content
POST
Create a ramp order

Authorizations

Authorization
string
header
required

Enter your Chainrails API key as a Bearer token

Body

application/json
type
enum<string>
required

Type of ramp order to create

Available options:
on-ramp,
off-ramp
Example:

"on-ramp"

provider
enum<string>
required

Ramp provider to use for this order

Available options:
FONBNK,
ONRAMP_MONEY,
GUARDARIAN,
YELLOW_CARD
Example:

"YELLOW_CARD"

fiatCurrency
string
required

ISO 4217 fiat currency code

Example:

"NGN"

cryptoAmount
number
required

Amount of crypto the user wants to receive (on-ramp) or sell (off-ramp). For off-ramp this is the amount of the selected source token.

Example:

10

destinationChain
enum<string>

Destination blockchain where user wants their funds (required for on-ramp)

Available options:
ARBITRUM_MAINNET,
ARBITRUM_TESTNET,
AVALANCHE_MAINNET,
AVALANCHE_TESTNET,
BASE_MAINNET,
BASE_TESTNET,
STARKNET_MAINNET,
STARKNET_TESTNET,
BSC_MAINNET,
ETHEREUM_MAINNET,
ETHEREUM_TESTNET,
OPTIMISM_MAINNET,
OPTIMISM_TESTNET,
MONAD_MAINNET,
MONAD_TESTNET,
POLYGON_MAINNET,
HYPEREVM_MAINNET,
LISK_MAINNET,
SOLANA_MAINNET,
SOLANA_TESTNET,
TRON_MAINNET
Example:

"BASE_MAINNET"

sourceChain
enum<string>

Source blockchain where user will send crypto from (required for off-ramp)

Available options:
ARBITRUM_MAINNET,
ARBITRUM_TESTNET,
AVALANCHE_MAINNET,
AVALANCHE_TESTNET,
BASE_MAINNET,
BASE_TESTNET,
STARKNET_MAINNET,
STARKNET_TESTNET,
BSC_MAINNET,
ETHEREUM_MAINNET,
ETHEREUM_TESTNET,
OPTIMISM_MAINNET,
OPTIMISM_TESTNET,
MONAD_MAINNET,
MONAD_TESTNET,
POLYGON_MAINNET,
HYPEREVM_MAINNET,
LISK_MAINNET,
SOLANA_MAINNET,
SOLANA_TESTNET,
TRON_MAINNET
Example:

"BASE_MAINNET"

amountSymbol
enum<string>

Token symbol for cryptoAmount (defaults to USDC)

Available options:
USDC,
USDT,
DAI,
BUSD,
EURC,
ETH,
WETH,
STRK,
BNB,
LORDS,
USDS,
USDG,
USDT0,
WBTC,
LINK,
SOL,
EKUBO,
AAVE,
UNI,
CURVE,
cbBTC,
VIRTUAL,
stETH,
wstETH,
SKY,
AUSD,
WMON,
LVMON,
OP,
WLD,
ARB,
sAVAX,
WAVAX,
anyBTC,
WBNB,
TRON,
AVAX,
POL,
MON
Example:

"USDC"

recipientAddress
string

Recipient wallet address on the destination chain (required for on-ramp)

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

senderAddress
string

User's crypto wallet address / sender (required for off-ramp)

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

countryCode
string

ISO 3166-1 alpha-2 country code of the user. Required for multi-country currencies (e.g., XOF — pass "BJ" for Benin, "SN" for Senegal). Falls back to the currency's default country if omitted.

Example:

"NG"

userEmail
string

End-user's email address. Required for direct orders.

fields
object

Provider-specific fields required by the payment channel (e.g., phone number, bank code)

Example:

Response

Ramp order created successfully