Retrieve a list of orders

GET 
/api/v1/orders

Get a paginated list of all orders, optionally filtered by integration.

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

The page number to retrieve.

quantity integer

Possible values: >= 1 and <= 100

Default value: 20

The number of items to retrieve per page.

integrationId string

The ID of the integration to filter orders by.

Responses

200

A list of orders.

application/json

Schema

Schema

data object[]
The list of orders.
Array [
id stringrequired
The unique identifier of the order.
status stringrequired
Possible values: [inProgress, completed, failed]
The current status of the order. Possible values include: inProgress: The order is currently being processed and has not yet been completed. completed: The payer has completed the order, and the funds have been credited to the merchant's wallet. failed: The client either did not complete the payment within the order's lifetime or did not fully pay the order if it was a payment order.
createdAt stringrequired
The timestamp when the order was created, in the ISO 8601 format, including the date, time, and timezone information.
updatedAt stringrequired
The timestamp when the order status was last updated, in the ISO 8601 format, including the date, time, and timezone information.
primaryAmount nullable
The amount and currency the merchant will receive after deducting the service fee.
amount stringrequired
The monetary value, as a decimal number with up to 6 decimal places.
currency stringrequired
Possible values: [USDT, TRX]
The currency of the amount.
secondaryAmount objectnullable
The amount and currency of the order in euros.
amount stringrequired
The monetary value, as a decimal number with up to 2 decimal places.
currency stringrequired
Possible values: [EUR]
The currency of the amount.
serviceFeeAmount nullable
The service fee applied to the order. The currency of the service fee always matches the currency of the primaryAmount.
amount stringrequired
The monetary value, as a decimal number with up to 6 decimal places.
currency stringrequired
Possible values: [EUR]
The currency of the amount.
totalAmount nullable
The total amount and currency involved in the order, including fees. This is the amount the payer actually paid.
amount stringrequired
The monetary value, as a decimal number with up to 6 decimal places.
currency stringrequired
Possible values: [USDT, TRX]
The currency of the amount.
]
pagination object

quantity integerrequired

The number of items per page.

totalQuantity integerrequired

The total number of items available.

currentPage integerrequired

The current page number.

pages integerrequired

The total number of pages available.

Example (from schema)

{
  "data": [
    {
      "id": "1ef65c5c-8fae-6bf2-91fd-73770edda314",
      "status": "inProgress",
      "createdAt": "2024-08-29T05:04:24+00:00",
      "updatedAt": "2024-08-29T05:34:02+00:00",
      "primaryAmount": {
        "amount": "0.995000",
        "currency": "USDT"
      },
      "secondaryAmount": {
        "amount": "0.14",
        "currency": "EUR"
      },
      "serviceFeeAmount": {
        "amount": "0.005000",
        "currency": "EUR"
      },
      "totalAmount": {
        "amount": "1.000000",
        "currency": "USDT"
      }
    }
  ],
  "pagination": {
    "quantity": 1,
    "totalQuantity": 1,
    "currentPage": 1,
    "pages": 1
  }
}

Loading...