Orders

Get off-ramp orders

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

GEThttps://sandbox-api.fonbnk.com/api/offramp/orders

Authorization

ClientIdHeaderTimestampHeaderSignatureHeader

Query parameters

Response

200

Successful response

Body

application/json

nextCursorstring

listarray of OfframpOrder (object)

Request

JavaScriptCurlPython

const response = await fetch('https://sandbox-api.fonbnk.com/api/offramp/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "nextCursor": "text",
  "list": [
    {
      "_id": "text",
      "offerId": "text",
      "paymentType": "CRYPTO_WALLET",
      "network": "AVALANCHE",
      "asset": "USDC",
      "exchangeRate": 0,
      "cashout": {
        "localCurrencyAmount": 0,
        "usdAmount": 0,
        "feeAmountUsd": 0,
        "feeAmountUsdFonbnk": 0,
        "feeAmountUsdPartner": 0,
        "feeAmountLocalCurrency": 0,
        "feeAmountLocalCurrencyFonbnk": 0,
        "feeAmountLocalCurrencyPartner": 0,
        "cryptoAmount": 0,
        "feeAmountCrypto": 0,
        "feeAmountCryptoFonbnk": 0,
        "feeAmountCryptoPartner": 0
      },
      "fromAddress": "text",
      "toAddress": "text",
      "status": "initiated",
      "createdAt": "2024-11-21T06:21:28.945Z",
      "expiresAt": "2024-11-21T06:21:28.945Z",
      "hash": "text",
      "statusHistory": [
        {
          "status": "initiated",
          "changedAt": "2024-11-21T06:21:28.945Z"
        }
      ],
      "countryIsoCode": "text",
      "currencyIsoCode": "text",
      "offerRequiredFields": [
        {
          "label": "text",
          "type": "text",
          "value": "text"
        }
      ],
      "orderParams": "text"
    }
  ]
}