HOhoruslabsio
Ramp

Create a ramp order

Changed on

Creates an on-ramp or off-ramp order with the selected provider.

post/ramp/orders

Request

Request body

type'on-ramp' | 'off-ramp' required

Type of ramp order to create

provider'FONBNK' | 'ONRAMP_MONEY' | 'GUARDARIAN' | 'YELLOW_CARD' required

Ramp provider to use for this order

fiatCurrencystring required

ISO 4217 fiat currency code

cryptoAmountnumber 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.

destinationChain'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'

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

sourceChain'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'

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

amountSymbol'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'

Token symbol for cryptoAmount (defaults to USDC)

recipientAddressstring

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

senderAddressstring

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

countryCodestring

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.

userEmailstring

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

fieldsobject

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

Example request

{
  "type": "on-ramp",
  "provider": "YELLOW_CARD",
  "fiatCurrency": "NGN",
  "cryptoAmount": 10,
  "destinationChain": "BASE_MAINNET",
  "sourceChain": "BASE_MAINNET",
  "amountSymbol": "USDC",
  "recipientAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "senderAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "countryCode": "NG",
  "userEmail": "user@example.com",
  "fields": {
    "phoneNumber": "+2348012345678"
  }
}

Response

Ramp order created successfully

Changes

  • dcf19c1bab20Revision changes
    • info

      added the new YELLOW_CARD enum value to the request property

  • 76a4e00b118dRevision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the new GUARDARIAN enum value to the request property

    • info

      added the new SOLANA_MAINNET enum value to the request property

    • info

      added the new SOLANA_TESTNET enum value to the request property

    • info

      added the new TRON_MAINNET enum value to the request property