Miscellaneous
Get quote
curl --request POST \
--url https://api.onswitch.xyz/onramp/quote \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"amount": 150050,
"country": "NG",
"asset": "base:usdc",
"currency": "NGN",
"channel": "BANK",
"exact_output": false,
"developer_fee": 0.5,
"developer_recipient": "0x1234567890123456789012345678901234567890"
}
'{
"success": true,
"message": "Quote fetched successfully",
"timestamp": "2024-01-01T00:00:00.000Z",
"data": {
"rate": 1500.5,
"expiry": "2024-01-01T00:05:00.000Z",
"settlement": "Same day",
"channel": "BANK",
"fee": {
"total": 5,
"platform": 4.5,
"developer": 0.5,
"currency": "NGN"
},
"fee_inclusive": true,
"source": {
"amount": 150050,
"currency": "NGN"
},
"destination": {
"amount": 100,
"currency": "USDC"
}
}
}Get quote
Get a real-time quote for an onramp transaction including exchange rate, settlement time, and payment rail information.
POST
/
onramp
/
quote
Get quote
curl --request POST \
--url https://api.onswitch.xyz/onramp/quote \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"amount": 150050,
"country": "NG",
"asset": "base:usdc",
"currency": "NGN",
"channel": "BANK",
"exact_output": false,
"developer_fee": 0.5,
"developer_recipient": "0x1234567890123456789012345678901234567890"
}
'{
"success": true,
"message": "Quote fetched successfully",
"timestamp": "2024-01-01T00:00:00.000Z",
"data": {
"rate": 1500.5,
"expiry": "2024-01-01T00:05:00.000Z",
"settlement": "Same day",
"channel": "BANK",
"fee": {
"total": 5,
"platform": 4.5,
"developer": 0.5,
"currency": "NGN"
},
"fee_inclusive": true,
"source": {
"amount": 150050,
"currency": "NGN"
},
"destination": {
"amount": 100,
"currency": "USDC"
}
}
}Authorizations
Service key for API authentication
Body
application/json
Required range:
x >= 0Available options:
AD, AE, AF, AG, AI, AL, AM, EU, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, GZ, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, false, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Available options:
base:usdc, solana:usdc, solana:usdt, ethereum:usdc, ethereum:usdt, polygon:usdc, polygon:usdt, bsc:usdc, bsc:usdt, arbitrum:usdc, optimism:usdc, gnosis:usdc, gnosis:usdt, arbitrum:usdt, avalanche:usdc, monad:usdc, optimism:usdt, monad:usdt, plasma:usdt, avalanche:usdt, tron:usdt, linea:usdt, mantle:usdt, hyperevm:usdt, berachain:usdt, linea:usdc, berachain:usdc, sonic:usdc, base:cngn, bsc:cngn Optional currency code. If not specified, defaults to the country's local currency.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWL Optional transfer channel. If not specified, defaults to the country's default channel.
Available options:
BANK, BLOCKCHAIN, SWIFT, SEPA, SEPA_EUR, WIRE, ACH, DOMESTIC_GBP, MOBILEMONEY, ALIPAY, WECHATPAY Optional developer fee percentage (0-100)
Required range:
0 <= x <= 100Optional wallet address to receive developer fee.
⌘I