On Ramp

On-ramp

Get list of supported assets

get
/api/pay-widget-merchant/assets

Returns a list of supported blockchain assets for the on-ramp

Authorizations
x-client-idstringRequired
Responses
chevron-right
200

Successful response

application/json
networkstring · enumOptionalPossible values:
assetstring · enumOptionalPossible values:
get
/api/pay-widget-merchant/assets
200

Successful response

Get order

get
/api/pay-widget-merchant/order

Returns a single pay widget order by its ID or orderParams query parameter.

Authorizations
x-client-idstringRequired
Query parameters
orderIdstringOptional

id of the order which you could receive via a webhook or iframe events

orderParamsstringOptional

Value which you provided in the orderParams parameter of the pay widget URL

Responses
chevron-right
200

Successful response

application/json
_idstringOptional

Order ID

walletTypestring · enumOptional

Network type

Possible values:
assetstring · enumOptional

Asset type

Possible values:
walletAddressstringOptional

User wallet address

feePercentnumberOptional

total fee percent (fonbnk fee + partner fee)

fonbnkFeePercentnumberOptional
partnerFeePercentnumberOptional
gasUsdAmountnumberOptional
merchantIdstringOptional
createdAtstring · date-timeOptional
feeAmountnumberOptional

Total fee amount in USD

localCurrencyFeeAmountnumberOptional

Total fee amount in local currency

fonbnkFeeAmountnumberOptional
localCurrencyFonbnkFeeAmountnumberOptional
partnerFeeAmountnumberOptional
localCurrencyPartnerFeeAmountnumberOptional
networkFeeAmountnumberOptional
localCurrencyNetworkFeeAmountnumberOptional
resumeUrlstringOptional
get
/api/pay-widget-merchant/order
200

Successful response

Get orders

get
/api/pay-widget-merchant/orders

Returns a paginated list of pay widget orders. Filters can be applied to the list by providing query parameters.

Authorizations
x-client-idstringRequired
Query parameters
cursorstringOptional

this parameter should be provided in order to get a next page from the pagination, it should be taken from "nextCursor" response value

limitintegerRequired

number from 1 to 100, describes how many records should be in each pagination page

walletTypestring · enumOptional

wallet type of orders

Possible values:
walletAddressstringOptional
userPhoneNumberstringOptional

phone number of the client, should include country code

userEmailstringOptional

email of the client

swapProviderstring · enumOptionalPossible values:
buySwapStatusstring · enumOptional
  • initiated: The buy swap has been initiated
  • expired: The buy swap has expired
  • buyer_confirmed: The buyer has confirmed the buy swap
  • seller_confirmation_pending: The agent is yet to confirm the buy swap
  • seller_confirmation_failed: The agent has failed to confirm the buy swap
  • seller_confirmed: The agent has confirmed the buy swap
  • seller_rejected: The agent has rejected the buy swap
Possible values:
withdrawalStatusstring · enumOptional

status of a crypto transfer

Possible values:
Responses
chevron-right
200

Successful response

application/json
get
/api/pay-widget-merchant/orders
200

Successful response

Get price

get
/api/pay-widget-merchant/price

Returns expected price in USDC, cUSD etc. for a given amount of mobile money and vice versa.

Authorizations
x-client-idstringRequired
Query parameters
networkstring · enumRequiredPossible values:
assetstring · enumRequiredPossible values:
currencystring · enumRequiredPossible values:
amountnumberRequired
countrystringRequired

country ISO code, e.g. NG

providerstring · enumRequiredPossible values:
carrierIdstringOptional
Responses
chevron-right
200

Successful response

application/json
quoteIdstringOptional

Unique quote id

cryptoTotalAmountnumberOptional

Amount of crypto user should receive before fees

cryptoWithdrawAmountnumberOptional

Amount of crypto user should receive after fees

cryptoFeeAmountnumberOptional

Total fee amount (fonbnk fee + partner fee) in crypto

cryptoGasAmountnumberOptional

Network fee in crypto

localCurrencyAmountnumberOptional

Amount of local currency user should pay

feePercentnumberOptional

Total fee percent (fonbnk fee + partner fee)

fonbnkFeePercentnumberOptional
partnerFeePercentnumberOptional
totalAmountnumberOptional

Amount of funds user will receive before fees

withdrawAmountnumberOptional

Amount of funds user will receive after fees

feeAmountnumberOptional

Total fee amount (fonbnk fee + partner fee)

localCurrencyFeeAmountnumberOptional

Total fee amount in local currency (fonbnk fee + partner fee)

fonbnkFeeAmountnumberOptional
localCurrencyFonbnkFeeAmountnumberOptional
partnerFeeAmountnumberOptional
localCurrencyPartnerFeeAmountnumberOptional
networkFeeAmountnumberOptional
localCurrencyNetworkFeeAmountnumberOptional
usdcTotalAmountnumberOptional

Amount of usd user will receive before fees (deprecated)

usdcWithdrawAmountnumberOptional

Amount of usd user will receive after fees (deprecated)

usdcFeeAmountnumberOptional

Fonbnk service fee (deprecated)

usdcGasAmountnumberOptional

Network fee (deprecated)

get
/api/pay-widget-merchant/price
200

Successful response

Get providers

get
/api/pay-widget-merchant/providers

Returns a list of providers. Optionally includes limitations data.

Authorizations
x-client-idstringRequired
Query parameters
includeLimitsbooleanOptional

Should limitations data be included in the response. Defaults to true. If limitations are not included the request will be much faster.

Default: true
networkstring · enumOptionalPossible values:
Responses
chevron-right
200

Successful response

application/json
countryIsoCodestringOptional
currencyIsoCodestringOptional
get
/api/pay-widget-merchant/providers
200

Successful response

Get limits

get
/api/pay-widget-merchant/limits

Returns minimum and maximum amount of order in crypto and local currency and applied fees.

Authorizations
x-client-idstringRequired
Query parameters
networkstring · enumRequiredPossible values:
assetstring · enumOptionalPossible values:
countrystringRequired
providerstring · enumRequiredPossible values:
carrierIdstringOptional
Responses
chevron-right
200

Successful response

application/json
localCurrencyLimitsone ofOptional
or
get
/api/pay-widget-merchant/limits
200

Successful response

Last updated