---
title: "Get best offer"
method: GET
path: "/api/onramp/best-offer"
tags: ["on-ramp"]
---

# Get best offer

`GET /api/onramp/best-offer`

## Request

- Base URL: `https://sandbox-api.fonbnk.com`
- URL: `https://sandbox-api.fonbnk.com/api/onramp/best-offer`
- Auth: one of:
  - API key in header `x-client-id`
  - API key in header `x-timestamp`
  - API key in header `x-signature`
- TypeScript: <https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/docs/api/onramp/best-offer/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `network` 'POLYGON' | 'ETHEREUM' | 'STELLAR' | 'AVALANCHE' | 'SOLANA' | 'CELO' | 'BASE' | 'TON' | 'TRON' | 'LISK' | 'ARBITRUM' | 'OPTIMISM' | 'BNB', required
- `asset` 'USDC' | 'USDT' | 'CUSD' | 'CKES' | 'CGHS' | 'USDE', required
- `currency` 'local' | 'crypto', required
- `amount` number, required
- `countryIsoCode` string, required
- `paymentChannel` 'bank' | 'mobile_money' | 'airtime', required
- `carrierCode` string

## Response `200`

Successful response

- OnRampBestOfferResponse
  - `quoteId` string: Unique quote id
  - `offer` object
    - `paymentChannel` 'bank' | 'mobile_money' | 'airtime'
    - `countryIsoCode` string: Country ISO code, e.g. NG for Nigeria, KE for Kenya
    - `currencyIsoCode` string: Local currency ISO code, e.g. NGN for Nigerian Naira, KES for Kenyan Shilling
    - `exchangeRate` number: Exchange rate for the order
    - `cryptoExchangeRate` number: Exchange rate for the crypto amount
    - `requiredFields` object: Data required to submit the order
  - `cashout` object
    - `localCurrencyAmount` number: Amount in local currency user must to pay
    - `totalAmountUsd` number: Total amount of local currency in USD user must to pay
    - `totalAmountCrypto` number: Total amount of local currency in crypto user must to pay
    - `withdrawAmountUsd` number: Amount in USD user will receive after the order is completed
    - `withdrawAmountCrypto` number: Amount in crypto user will receive after the order is completed
    - `feePercent` number: Total fee percent (fonbnk fee + partner fee)
    - `feeAmountUsd` number: Total fee amount in USD
    - `feeAmountLocalCurrency` number: Total fee amount in local currency
    - `feeAmountCrypto` number: Total fee amount in crypto
    - `feePercentFonbnk` number: Fonbnk fee percent
    - `feeAmountUsdFonbnk` number: Fonbnk fee amount in USD
    - `feeAmountLocalCurrencyFonbnk` number: Fonbnk fee amount in local currency
    - `feeAmountCryptoFonbnk` number: Fonbnk fee amount in crypto
    - `feePercentPartner` number: Partner fee percent
    - `feeAmountUsdPartner` number: Partner fee amount in USD
    - `feeAmountLocalCurrencyPartner` number: Partner fee amount in local currency
    - `feeAmountCryptoPartner` number: Partner fee amount in crypto
    - `gasAmountUsd` number: Gas fee amount in USD
    - `gasAmountLocalCurrency` number: Gas fee amount in local currency
    - `gasAmountCrypto` number: Gas fee amount in crypto

---

[API](https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api.md) - [All operations](https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/revisions/bae5de6fca88?raw)