off-ramp

Get best offer

Returns the best offer for the provided country, network, asset, amount and payment channel.

get/api/offramp/best-offer

Request

Base URL
https://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
TypeScript
https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/docs/api/offramp/best-offer/get.ts
A function with typed inputs. Its response is checked against the schema.

amountnumber required

Amount of usd user wants to pay or amount of local currency user wants to receive depending on the currency param value

currency'local' | 'crypto' required

Currency of the amount param

countryIsoCodestring required

country ISO code, for example KE for Kenya, NG for Nigeria

paymentChannel'bank' | 'airtime' | 'mobile_money' | 'paybill' required

type of the payment channel user wants to use, e.g. bank, mobile_money, airtime to receive local currency

network'AVALANCHE' | 'POLYGON' | 'CELO' | 'ETHEREUM' required

asset'USDC' | 'USDT' | 'CUSD' | 'CKES' | 'CGHS' required

Successful response

quoteIdstring

Unique quote id

No recorded changes to this operation across all 1 revision of this API.