Orders | Fonbnk Docs

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

get

/api/pay-widget-merchant/orders

Authorizations

Query parameters

cursorstring

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 · enum

wallet type of orders

Options: POLYGON, ETHEREUM, STELLAR, AVALANCHE, SOLANA, ALGORAND, CELO, BASE, TON, LISK, ARBITRUM, OPTIMISM, BNB

walletAddressstring

userPhoneNumberstring

phone number of the client, should include country code

swapProviderstring · enum

Options: bank_transfer, mobile_money, mpesa, carrier

buySwapStatusstring · enum

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

Options: initiated, expired, buyer_confirmed, seller_confirmation_pending, seller_confirmation_failed, seller_confirmed, seller_rejected

withdrawalStatusstring · enum

status of a crypto transfer

Options: pending, complete, failed

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://sandbox-api.fonbnk.com/api/pay-widget-merchant/orders?limit=1' \
  --header 'x-client-id: YOUR_API_KEY'

200

{
  "nextCursor": "651e764399a4b360c7eb0178",
  "list": [
    {
      "_id": "651e764399a4b360c7eb0178",
      "walletType": "SOLANA",
      "asset": "USDC",
      "walletAddress": "53L9ahwHcNnD4F11TqNHQgVUa75WgaCL2WGeiKiK2gCc",
      "feePercent": 2.5,
      "fonbnkFeePercent": 1.5,
      "partnerFeePercent": 1,
      "gasUsdAmount": 0,
      "merchantId": "645a20cbaf1d31dbd52c0fda",
      "createdAt": "2023-10-05T08:39:31.691Z",
      "feeAmount": 0.05,
      "localCurrencyFeeAmount": 50,
      "fonbnkFeeAmount": 0.03,
      "localCurrencyFonbnkFeeAmount": 30,
      "partnerFeeAmount": 0.02,
      "localCurrencyPartnerFeeAmount": 20,
      "networkFeeAmount": 0,
      "localCurrencyNetworkFeeAmount": 0,
      "resumeUrl": "https://pay.fonbnk.com/swap-status?orderId=651e764399a4b360c7eb0178",
      "buySwap": {
        "_id": "651e764399a4b360c7eb016d",
        "buyerUserPhone": "380962669394",
        "sellerUserPhone": "380960000000",
        "amount": 210,
        "airtimeAmount": 2100,
        "status": "seller_confirmed",
        "provider": "bank_transfer",
        "expiresAt": "2023-10-05T09:39:31.492Z",
        "createdAt": "2023-10-05T08:39:31.500Z",
        "buyerConfirmedAt": "2023-10-05T08:39:37.027Z",
        "countryIsoCode": "NG"
      },
      "withdrawal": {
        "_id": "651e7653db37ee6b74883fe1",
        "status": "complete",
        "withdrawAmount": 2,
        "withdrawCryptoAmount": 2,
        "transactionHash": "F19TfyGxBgebZt4q8h5bgf9Luabpypm3zSSzWR5ZUp8CKGNvL2r58zqGvWXvKftppiWKszV11jNQtsMUoFppmyb"
      }
    }
  ]
}

Successful response

Get orders