Order

Get all orders

Returns all orders

get/order/all

Response

Order response

statusstring string

Example response

{
  "status": "ok",
  "data": [
    {
      "orderId": "99854-2345",
      "quoteId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "isValid": true,
      "amount": "1000.00",
      "createdAt": "2021-07-01T12:00:00Z",
      "updatedAt": "2021-07-01T12:00:00Z",
      "quotes": [
        {
          "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
          "exchangeRate": 103830225.71866913,
          "usdToTargetCurrencyRate": 1500.65,
          "transactionFeesInSourceCurrency": 13.23,
          "transactionFeesInTargetCurrency": "3750.00",
          "amountInSourceCurrency": 1499,
          "amountInTargetCurrency": "50000.00",
          "expiry": "2021-07-01T12:00:00Z",
          "isValid": true,
          "invoice": "lntbs36020n1pnehfzcpp5zc8g9tfpwnmaevh62ak2vu6zjqyt5cpph3gjm4zfyqz9srjjdsaqdz5296k7ar98gsy6ctkvys9qcteyqmnyenr8yunswfdvyer2v3dx33kxe3dvymnsefdv5mnjcm9x5mrydm9vccqcqzpuxqzfvsp5utd7hdfmjp7vw3lc6hal8psqruwcnu89hxfukyzugxh40jhv8xcq9qxpqysgq2lry5dgzu2g04s74tpvctwe37rkprs3k579jw6yt7ncrsg62p29yalw8gf5fawfvpydqv4jjve0nsysfhsxa35dtwug9e6gzxkq0h5gp636wc3",
          "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
          "customerReference": "order-1234567890",
          "totalAmountInSourceCurrency": 1499,
          "createdAt": "2021-07-01T12:00:00Z",
          "updatedAt": "2021-07-01T12:00:00Z",
          "bankName": "WEMA BANK",
          "ngnBankAccountNumber": "7824655568",
          "ngnAccountName": "Mava Digital Solutions Limited",
          "ngnBankCode": "000027",
          "orderId": "43477-4306"
        }
      ],
      "transactions": [
        {
          "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
          "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
          "ref": "99eeff854ffd345fffs67890",
          "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
          "amount": 1000,
          "autopayout": true,
          "createdAt": "2021-07-01T12:00:00Z",
          "updatedAt": "2021-07-01T12:00:00Z",
          "metadata": {
            "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
            "orderId": "99854-2345",
            "bankCode": "090267",
            "bankAccountName": "Satoshi Nakamoto",
            "bankAccountNumber": "0123456789",
            "createdAt": "2021-07-01T12:00:00Z",
            "updatedAt": "2021-07-01T12:00:00Z"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 7 of the 32 revisions of this API.514

    • added the new USDT enum value to the data/items/transactions/items/currency response property for the response status 200

      response-property-enum-value-added

    • added the new GHS enum value to the data/items/transactions/items/currency response property for the response status 200

      response-property-enum-value-added

    • added the new GHSPESEWA enum value to the data/items/quotes/items/targetCurrency response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/items/quotes/items/customerReference to the response with the 200 status

      response-optional-property-added

    • removed the KESCENT enum value from the data/items/quotes/items/sourceCurrency response property for the response status 200

      response-property-enum-value-removed

    • removed the ZARCENT enum value from the data/items/quotes/items/sourceCurrency response property for the response status 200

      response-property-enum-value-removed

    • added the optional property data/items/quotes/items/bankName to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/quotes/items/estimatedRoutingFee to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/quotes/items/ngnAccountName to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/quotes/items/ngnBankAccountNumber to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/quotes/items/ngnBankCode to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/quotes/items/orderId to the response with the 200 status

      response-optional-property-added

    • removed the TRANSFER enum value from the data/items/transactions/items/type response property for the response status 200

      response-property-enum-value-removed

    • removed the optional property data/items/transactions/items/transactionMetadata from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/transactions/items/metadata to the response with the 200 status

      response-optional-property-added

    • removed the optional property data/items/quote from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/quotes to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/transactions to the response with the 200 status

      response-optional-property-added

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

    • endpoint added

      endpoint-added