Best offer

Get best offer

Returns the best offer for the provided country, network, asset, amount and off-ramp type.

get

/api/offramp/best-offer

Authorizations

ClientIdHeaderTimestampHeaderSignatureHeader

Query parameters

amountnumberrequired

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

currencystring · enumrequired

Currency of the amount param

Options: local, usd

countrystringrequired

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

typestring · enumrequired

Options: bank, airtime, mobile_money, paybill

networkstring · enumrequired

Options: AVALANCHE, POLYGON, CELO, ETHEREUM

assetstring · enumrequired

Options: USDC, USDT, CUSD, CKES

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sandbox-api.fonbnk.com/api/offramp/best-offer?amount=1&currency=local&country=text&type=bank&network=AVALANCHE&asset=USDC' \
  --header 'x-client-id: YOUR_API_KEY'

200

200

{
  "cashout": {
    "localCurrencyAmount": 6301,
    "usdAmount": 5,
    "feeAmountUsd": 0.12,
    "feeAmountUsdFonbnk": 0.12,
    "feeAmountUsdPartner": 0,
    "feeAmountLocalCurrency": 155,
    "feeAmountLocalCurrencyFonbnk": 155,
    "feeAmountLocalCurrencyPartner": 0,
    "cryptoAmount": 5,
    "feeAmountCrypto": 0.12,
    "feeAmountCryptoFonbnk": 0.12,
    "feeAmountCryptoPartner": 0
  },
  "offer": {
    "_id": "65b8c6b8b188250081f30165",
    "countryIsoCode": "NG",
    "currencyIsoCode": "NGN",
    "exchangeRate": 1260.2,
    "type": "bank",
    "requiredFields": {
      "phoneNumber": {
        "type": "phone",
        "label": "Phone number",
        "required": true
      },
      "buyerBankAccountNumber": {
        "type": "string",
        "label": "Bank account Number",
        "required": true
      },
      "bankCode": {
        "required": true,
        "type": "enum",
        "label": "Bank name",
        "options": [
          {
            "value": "120001:02",
            "label": "9Payment Service Bank"
          },
          {
            "value": "801:02",
            "label": "Abbey Mortgage Bank"
          }
        ]
      }
    }
  }
}

Successful response