> For the complete documentation index, see [llms.txt](https://docs.xpayconnect.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xpayconnect.io/documentation/eng/orders/list.md).

# Order List

> Method: **GET**
>
> Path: **/merchant/orders**

## Request Parameters

| Field             | Type              | Required | Description                                                                       |
| ----------------- | ----------------- | -------- | --------------------------------------------------------------------------------- |
| **merchant\_id**  | string            | yes      | Unique merchant name                                                              |
| **page**          | integer           | no       | Page number. Default: `1`                                                         |
| **size**          | integer           | no       | Items per page. Default: `10`, maximum: `100`                                     |
| **type**          | string (enum)     | no       | Filter by [payment method](/documentation/eng/orders/create.md#platezhnye-metody) |
| **order\_status** | string (enum)     | no       | Filter by status: `pending`, `success`, `error`                                   |
| **start\_date**   | string (datetime) | no       | Start of period, format: `2025-02-06 00:00:00`. UTC. Default: current day         |
| **end\_date**     | string (datetime) | no       | End of period, format: `2025-02-06 23:59:59`. UTC. Default: current day           |

### Request Examples

{% tabs %}
{% tab title="JavaScript" %}

```javascript
const crypto = require('crypto');
const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const xApiKey = crypto.createHash('sha256').update(`${apiKey}|`).digest('hex');

const { data } = await axios.get('https://api.xpayconnect.io/merchant/orders', {
    params: { merchant_id: 'exMerchant', page: 1, size: 10 },
    headers: { 'client-api-key': apiKey, 'x-api-key': xApiKey },
});
```

{% endtab %}

{% tab title="Python" %}

```python
import hashlib
import requests

api_key = 'YOUR_API_KEY'
x_api_key = hashlib.sha256(f'{api_key}|'.encode()).hexdigest()

resp = requests.get('https://api.xpayconnect.io/merchant/orders', params={
    'merchant_id': 'exMerchant', 'page': 1, 'size': 10,
}, headers={'client-api-key': api_key, 'x-api-key': x_api_key})
data = resp.json()
```

{% endtab %}

{% tab title="PHP" %}

```php
$apiKey = 'YOUR_API_KEY';
$xApiKey = hash('sha256', $apiKey . '|');
$url = 'https://api.xpayconnect.io/merchant/orders?' . http_build_query([
    'merchant_id' => 'exMerchant', 'page' => 1, 'size' => 10,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['client-api-key: ' . $apiKey, 'x-api-key: ' . $xApiKey],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
```

{% endtab %}
{% endtabs %}

***

## Response

```json
{
    "ok": true,
    "total": 3,
    "orders": [
        {
            "id": "lux019dde94-0c92-746e-9bbc-6041608c469d",
            "payment_id": "11664",
            "status": "success",
            "success_callback_url": "https://example.com/wbh",
            "created_at": "2026-04-30T13:28:57.764Z",
            "convertToUsdt": true,
            "currency": "KZT",
            "usdtAmount": 47.87,
            "usdtAmountAfterFee": 41.65,
            "amountAfterFee": 19891.43,
            "exchangeRate": 463.2823486606767,
            "payment_details": {
                "address": "4400430353907287",
                "bank": "Kaspi Bank (KZ)",
                "holder_name": "ARTUR RUZIBOEV",
                "type": "card",
                "amount": "22305"
            }
        }
    ]
}
```

| Field                                  | Type              | Description                                                                                                                                                                                                                      |
| -------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ok**                                 | boolean           | `true` on a successful request                                                                                                                                                                                                   |
| **total**                              | integer           | Total number of orders matching the filter                                                                                                                                                                                       |
| **orders**                             | array             | Array of orders                                                                                                                                                                                                                  |
| **orders\[\*].id**                     | string            | Unique identifier in the system (internal\_id)                                                                                                                                                                                   |
| **orders\[\*].payment\_id**            | string            | Merchant-side identifier                                                                                                                                                                                                         |
| **orders\[\*].status**                 | string (enum)     | `pending`, `success`, `error`                                                                                                                                                                                                    |
| **orders\[\*].success\_callback\_url** | string, null      | URL to which the webhook is sent on success                                                                                                                                                                                      |
| **orders\[\*].created\_at**            | string (datetime) | Creation date and time                                                                                                                                                                                                           |
| **orders\[\*].currency**               | string (enum)     | Order currency: `RUB`, `KGS`, `KZT`, `UZS`                                                                                                                                                                                       |
| **orders\[\*].usdtAmount**             | number, null      | Estimated amount in USDT **WITHOUT** commission. For fiat methods = `amount / exchangeRate` (when `convertToUsdt: true`); for `usdt_trc20` = amount from `cryptoAmount`                                                          |
| **orders\[\*].usdtAmountAfterFee**     | number, null      | Amount in USDT credited to the merchant's USDT balance **after** commission. Before `success` — an estimate; after `success` — the final value                                                                                   |
| **orders\[\*].amountAfterFee**         | number            | Amount in fiat currency after deducting the merchant commission. Before `success` — an estimate; after `success` — the final value. Always returned                                                                              |
| **orders\[\*].exchangeRate**           | number, null      | Fixed USDT/`currency` exchange rate (fiat methods with `convertToUsdt: true`)                                                                                                                                                    |
| **orders\[\*].convertToUsdt**          | boolean           | Flag passed by the merchant at order creation: whether revenue will be converted and credited to the USDT balance                                                                                                                |
| **orders\[\*].payment\_details**       | object            | Payment details information (similar to [order information](/documentation/eng/orders/info.md)) — includes `address`, `bank`, `holder_name`, `type`, `amount` (final amount to pay) and `cryptoAmount` (for crypto methods only) |