Sign in
exchange-external-api

Retrieve list of exchange orders

get/exchange/api/orders

Query parameters

fromstring date

15-04-2022

tostring date

15-08-2022

sizeinteger
pageinteger
transactionType'ONRAMP' | 'OFFRAMP'
statusesGetExchangeOrdersExternalStatusesEnum[]
tokenstring
fiatstring
networkstring

Response

Success

pageNumberinteger
pageSizeinteger
totalPagesinteger
totalOrdersinteger

Example response

{
  "orders": [
    {
      "reference": "0165359005113074501885",
      "customerName": "John Doe",
      "offer": {
        "rate": 0.32,
        "networkId": "TRC20",
        "fiatSymbol": "NGN",
        "fiatAmount": 120.5,
        "token": "USDT",
        "tokenAmount": 120.5,
        "partnerDisplayName": "John Doe"
      },
      "paymentChannelId": "BANK_TRANSFER_NIGERIA",
      "customerWallet": {
        "networkId": "bsc_testnet",
        "walletName": "My Trust Wallet"
      }
    }
  ]
}

Changes

Changed in 1 of the 6 revisions of this API.2

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog