on-ramp
Get best offer
Returns the best offer for the provided country, network, asset, amount and payment channel.
get/api/onramp/best-offer
Request
- Base URLhttps://sandbox-api.fonbnk.com
- Auth
- API key in header x-client-id
- or API key in header x-timestamp
- or API key in header x-signature
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
network'POLYGON' | 'ETHEREUM' | 'STELLAR' | 'AVALANCHE' | 'SOLANA' | 'CELO' | 'BASE' | 'TON' | 'TRON' | 'LISK' | 'ARBITRUM' | 'OPTIMISM' | 'BNB' required
blockchain network of the order
asset'USDC' | 'USDT' | 'CUSD' | 'CKES' | 'CGHS' | 'USDE' required
asset of the order
currency'local' | 'crypto' required
Currency of the amount param
amountnumber required
Amount of local currency user wants to pay or amount of crypto user wants to receive depending on the currency param value
countryIsoCodestring required
country ISO code, e.g. NG, KE etc.
paymentChannel'bank' | 'mobile_money' | 'airtime' required
type of the payment channel user wants to use, e.g. bank, mobile_money, airtime to pay local currency
carrierCodestring
carrier code if applicable, e.g. for mobile_money or airtime orders
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.