# Список счетов

### Что делает метод

* Возвращает список всех счетов
* Максимальное количество записей за один запрос — 100
* По умолчанию в ответе будет 10 записей

### Endpoint

<mark style="color:green;">`POST`</mark> `https://api.cryptocloud.plus/v2/invoice/merchant/list`

### Headers

| Name                                            | Type   | Example                             | Description      |
| ----------------------------------------------- | ------ | ----------------------------------- | ---------------- |
| Authorization<mark style="color:red;">\*</mark> | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | API-ключ проекта |

### Request Body

Основные параметры

| Name                                    | Type   | Example    | Description                                                                                                                                                                               |
| --------------------------------------- | ------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start<mark style="color:red;">\*</mark> | string | 01.01.2026 | Дата в формате "dd.mm.yyyy"                                                                                                                                                               |
| end<mark style="color:red;">\*</mark>   | string | 31.01.2026 | <p>Дата в формате "dd.mm.yyyy". </p><p><br></p><p>Должна быть больше или равна  start</p>                                                                                                 |
| offset                                  | int    | 0          | <p>Это номер начальной записи, с которой начнется вывод данных. <br></p><p>Например, если установить offset=10, то данные начнут показываться с 11-й записи</p>                           |
| limit                                   | int    | 10         | <p>Это номер последней записи, которую вы хотите получить. </p><p><br></p><p>Например, если limit=20, то вы получите записи до 20-й включительно, начиная с той, что указана в offset</p> |

### Пример запроса

Эти примеры показывают, как можно отправить запрос для получения списка счетов в рамках указанных лимитов

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

```bash
curl -X POST https://api.cryptocloud.plus/v2/invoice/merchant/list \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"start":"01.01.2023","end":"31.01.2023","offset":0,"limit":10}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.cryptocloud.plus/v2/invoice/merchant/list"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "start": "01.01.2023",
    "end": "31.01.2023",
    "offset": 0,
    "limit": 10
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Fail:", response.status_code, response.text)
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
fetch('https://api.cryptocloud.plus/v2/invoice/merchant/list', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        start: '01.01.2023',
        end: '31.01.2023',
        offset: 0,
        limit: 10
    })
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Fail: ' + response.status + ' ' + response.statusText);
    }
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.cryptocloud.plus/v2/invoice/merchant/list");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    "start" => "01.01.2023",
    "end" => "31.01.2023",
    "offset" => 0,
    "limit" => 10
)));

$headers = array(
    "Authorization: Token <API KEY>",
    "Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    $statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($statusCode == 200) {
        echo "Success: " . $response;
    } else {
        echo "Fail: " . $statusCode . " " . $response;
    }
}

curl_close($ch);
?>
```

{% endtab %}
{% endtabs %}

### Пример ответа

На успешный запрос приходит ответ со статусом success и объектом result.

{% tabs %}
{% tab title="200: OK - List received" %}

```json
{
    "status": "success",
    "result": [
       {
           "uuid": "INV-89UX09KA",
           "created": "2026-01-01 09:03:58.958133",
           "address": "0xb07427fc721C23674c48233ffE93D3846ee58B63",
           "currency": {
               "id": 3,
               "code": "ETH",
               "fullcode": "ETH",
               "network": {
                   "code": "ERC20",
                   "id": 3,
                   "icon": "https://cdn.cryptocloud.plus/img/network/ERC.svg",
                   "fullname": "Ethereum"
               },
               "name": "Ethereum",
               "is_email_required": false,
               "stablecoin": false,
               "icon_base": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",
               "icon_network": "https://cdn.cryptocloud.plus/img/currency/ETH.svg",
               "icon_qr": "https://cdn.cryptocloud.plus/img/stroke/ETH_STROKE.svg",
               "order": 9
           },
           "date_finished": "2026-01-01 19:27:37.258735",
           "expiry_date": "2026-01-02 09:03:57.493361",
           "side_commission": "client",
           "side_commission_cc": "merchant",
           "type_payments": "crypto",
           "status": "paid",
           "invoice_status": "success",
           "is_email_required": false,
           "project": {
               "id": 1,
               "name": "Test",
               "fail": "None",
               "success": "None",
               "logo": null
           },
           "tx_list": [
               "0x4d52dc2d2fa8555ab10211bd6c9a7aed13e6f9e1901090b03e7bf74603178c15",
                          ],
           "test_mode": false,
           "type": "up",
           "user_email": "a**********b@gmail.com",
           "pay_url": "None",
           "phone": "",
           "order_id": "None",
           "amount_in_crypto": null,
           "amount_in_fiat": 1.0,
           "amount": 0.000693,
           "amount_usd": 1.0,
           "amount_to_pay": 0.000694,
           "amount_to_pay_usd": 2.03,
           "amount_paid": 0.000694,
           "amount_paid_usd": 2.03,
           "fee": 1e-06,
           "fee_usd": 0.0,
           "service_fee": 1.2e-05,
           "service_fee_usd": 0.04,
           "received": 0.000681,
           "received_usd": 1.99,
           "to_surcharge": 0.0,
           "to_surcharge_usd": 0.0
       }

    ],
    "all_count": 2
}
```

{% endtab %}
{% endtabs %}

### Параметры ответа

На успешный запрос приходит ответ со статусом success и объектом result.

Объект result содержит:

| Name                 | Type   | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                                                          |
| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uuid                 | string | INV-89UX09KA                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Уникальный идентификатор счета с префиксом INV                                                                                                                                                                       |
| created              | string | 2026-01-01 12:00:00.000000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Время создания счета по UTC +0 в формате YYYY-MM-DD HH:MI:SS.FFFFFF                                                                                                                                                  |
| address              | string | 0xb07427<...>E93D3846ee58B63                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Адрес для оплаты                                                                                                                                                                                                     |
| expiry\_date         | string | 2026-01-02 12:00:00.000000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | <p>Дата истечения срока действия счета по UTC +0 в формате YYYY-MM-DD HH:MI:SS.FFFFFF</p><p></p><p>После истечения срока действия счет переведется в статус canceled,  если оплата не поступила</p>                  |
| side\_commission     | string | client                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Сторона оплаты трансферной комиссии                                                                                                                                                                                  |
| side\_commission\_cc | string | client                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Сторона оплаты комиссии сервиса                                                                                                                                                                                      |
| amount               | float  | 0.033366                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Сумма счета в выбранной криптовалюте                                                                                                                                                                                 |
| amount\_usd          | float  | 100.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Сумма счета в USD                                                                                                                                                                                                    |
| amount\_in\_fiat     | float  | 100.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Сумма счета в валюте создания (зависит от параметра currency)                                                                                                                                                        |
| fee                  | float  | 4.500000159168849e-06                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Трансферная комиссия счета                                                                                                                                                                                           |
| fee\_usd             | float  | 0.01                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Трансферная комиссия счета в USD                                                                                                                                                                                     |
| service\_fee         | float  | 0.000634                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Комиссия сервиса                                                                                                                                                                                                     |
| service\_fee\_usd    | float  | 1.9                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Комиссия сервиса в USD                                                                                                                                                                                               |
| fiat\_currency       | string | USD                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Код фиатной валюты, в которой был создан счет                                                                                                                                                                        |
| status               | string | created                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | <p>Статус счета <br></p><p>При отправке запроса на создание счета всегда равен created. </p><p></p><p>Так же есть статусы paid (оплачен), partial (оплачен частично), overpaid (переплачен) и canceled (отменен)</p> |
| is\_email\_required  | bool   | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Параметр для обязательного заполнения почты в счете                                                                                                                                                                  |
| link                 | string | pay.cryptocloud.plus/89UX09KA                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Ссылка на страницу счета                                                                                                                                                                                             |
| currency             | dict   | <p>"currency": {</p><p>            "id": 3,</p><p>            "code": "ETH",</p><p>            "fullcode": "ETH",</p><p>            "network": {</p><p>                "code": "ERC20",</p><p>                "id": 3,</p><p>                "icon": "<https://cdn.cryptocloud.plus/img/network/ERC.svg>",</p><p>                "fullname": "Ethereum"</p><p>            },</p><p>            "name": "Ethereum",</p><p>            "is\_email\_required": false,</p><p>            "stablecoin": false,</p><p>            "icon\_base": "<https://cdn.cryptocloud.plus/img/currency/ETH.svg>",</p><p>            "icon\_network": "<https://cdn.cryptocloud.plus/img/currency/ETH.svg>",</p><p>            "icon\_qr": "<https://cdn.cryptocloud.plus/img/stroke/ETH_STROKE.svg>",</p><p>            "order": 9</p><p>        }</p> | <p>Объект выбранной криптовалюты в счете. <br></p><p>Так же содержит объект network — информация о выбранной сети валюты</p>                                                                                         |
| project              | dict   | <p>"project": {</p><p>            "id": 0,</p><p>            "name": "MyShop",</p><p>            "fail": "<https://test.com/failed-payment>",</p><p>            "success": "<https://test.com/successful-payment>",</p><p>            "logo": "<https://static.cryptocloud.plus/logo/logo.jpg>"</p><p>        }</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Объект с информацией о проекте                                                                                                                                                                                       |
| test\_mode           | bool   | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Признак тестового счета                                                                                                                                                                                              |
| received             | float  | <p>0.00206</p><p><br></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Зачисленная на баланс сумма в криптовалюте                                                                                                                                                                           |
| received\_usd        | float  | <p>0.26<br></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Зачисленная на баланс сумма в USD                                                                                                                                                                                    |
| to\_surcharge        | float  | <p>0.001172</p><p><br></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Сумма к доплате в криптовалюте                                                                                                                                                                                       |
| to\_surcharge\_usd   | float  | <p>0.08</p><p><br></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Сумма к доплате в USD                                                                                                                                                                                                |

> Мы регулярно работаем над улучшением документации сервиса для разработчиков. Пожалуйста, оцените качество и полезность материалов [по ссылке](https://survey.zohopublic.eu/zs/G6TdRh).
