Returns a lists of orders.

curl -G https://api-sandbox.koywe.com/rest/orders \
     -H "Authorization: Bearer <token>" \
     -d pageSize=1.1 \
     -d pageNumber=1.1

{
  "data": [
    {
      "orderId": "b88f4ed0-10a2-412f-be3e-b5e47abe9b50",
      "quoteId": "quoteId",
      "orderType": "currency-crypto",
      "symbolIn": "CLP",
      "symbolOut": "MATIC",
      "amountIn": 25000,
      "amountOut": 32.171150520770496,
      "email": "example@gmail.com",
      "exchangeRate": 746.01,
      "koyweFee": 1000,
      "partnerFee": 500,
      "networkFee": 1000,
      "status": "REJECTED",
      "statusDetails": "statusDetails",
      "outReceipt": "98abd8a6dbdba6d4b",
      "bankAccountId": "6294d815d2b5f912da43e699",
      "txHash": "txHash",
      "metaData": "metaData",
      "externalId": "A1d2t3456",
      "feesInFiat": {
        "koyweFee": 10,
        "netFee": 1,
        "partnerFee": 0.5
      },
      "feesInUSD": {
        "koyweFee": 10,
        "netFee": 1,
        "partnerFee": 0.5
      },
      "dates": {
        "confirmationDate": "2023-01-01T10:00:00Z",
        "paymentDate": "2023-01-01T12:00:00Z",
        "executionDate": "2023-01-01T14:00:00Z",
        "deliveryDate": "2023-01-01T16:00:00Z"
      },
      "destinationAddress": "0x40f9bf922c23c43acede50Ab4425280C0ffBD697",
      "paymentMethodId": "6294d815d2b5f912da43e699",
      "logoIn": "urlExample.com/currencies/CLP.svg",
      "logoOut": "urlExample.com/currencies/MATIC.svg",
      "refund": {
        "destinationAddress": "0x40f9bf922c23c43acede50Ab4425280C0ffBD697",
        "transactionReceipt": "98abd8a6dbdba6d4b"
      }
    }
  ],
  "pagination": {
    "totalcount": 30,
    "pageSize": 6,
    "pageNumber": 5
  }
}

To try these services, an Authorization token must be provided as a BearerToken header. The Authorization token can be obtained in the /auth service.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageSizedoubleRequired

This value has a limit of 50, represents the number of responses per page.

pageNumberdoubleRequired

Number of pages shown.

initDatestringOptional

The initial date from which records are retrieved. Format: YYYY-MM-DD. Records from this date onwards will be included unless an ‘endDate’ is specified.

endDatestringOptional

The end date until which records are retrieved. Format: YYYY-MM-DD. Only records up to this date will be included. If omitted, records up to the current date are returned.

Response

successful operation

datalist of objects

paginationobject

Errors

400

Order Request Bad Request Error

404

Order Request Not Found Error