Список счетов
Запрос
curl -X POST https://api.bitsby.app/invoices/list \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay" \
-F "startDate=2000-01-01" \
-F "endDate=2030-01-01" \
-F "offset=0" \
-F "limit=10"
Параметры запроса
| Параметр | Тип данных | Описание | Пример | Обязательный? | По умолчанию |
|---|---|---|---|---|---|
invoiceId | UUID | ID счета в формате UUID | 1c48b092-9878-48f5-b441-07a8a48e7b54 | нет | |
invoiceUid | String | ID счета (для покупателя) | F7ncQviM1N92 | нет | |
projectId | UUID | ID проекта в формате UUID | 1c48b092-9878-48f5-b441-07a8a48e7b54 | нет | |
startDate | String | Начальная дата создания счета в формате Y-m-d | 2000-01-01 | нет | |
endDate | String | Конечная дата создания счета в формате Y-m-d | 2030-01-01 | нет | |
status | String | Статус счета. Допустимые значения: unpaid, canceled, paid, expired | paid | нет | |
offset | Integer | Номер начальной записи, с которой начнется вывод данных | 0 | нет | 0 |
limit | Integer | Количество записей, которые вы хотите получить | 50 | нет | 10 |
Пример ответа
{
"result": "success",
"data": [
{
"id": "59302b02-d1be-4e10-960f-d6ec24bfcaaf",
"uid": "F7nYgvxM1N92",
"projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
"createDatetime": "2024-02-29 10:49:56",
"timeToPayDatetime": "2024-02-29 22:49:56",
"commissionFiatUSD": 1,
"amountFiatUSD": 100,
"amountFiat": 100,
"currencyFiat": "USD",
"description": null,
"serviceData": null,
"views": 0,
"status": "canceled"
},
{
"id": "f31c61f6-407f-4999-95cf-56477eff06d4",
"uid": "riUZBnNvd2rX",
"projectId": "9deea1e2-0c08-41a3-bdc2-a34eada3892d",
"createDatetime": "2024-02-27 20:57:23",
"timeToPayDatetime": "2024-02-28 08:57:23",
"commissionFiatUSD": 0.12,
"amountFiatUSD": 12,
"amountFiat": 12,
"currencyFiat": "USD",
"description": null,
"serviceData": "orderId:2444",
"views": 3,
"status": "paid",
"payment": {
"id": "f986ad8d-2298-473d-982a-efbc817b975d",
"amount": 12,
"hash": "f09352627039c088688806821b864895ff237558612d834861621fc026de5f68",
"transactionDatetime": "2024-02-27 21:05:36"
},
"wallet": {
"id": "47aa71e2-07a0-482e-9172-7114d7376ba0",
"name": "usdt-tron",
"blockchain": "tron",
"cryptocurrency": "usdt",
"address": "TKbstUwMzLrfTAGL4erYb7gc7ghmHQ9zG7"
}
}
]
}
Параметры ответа
| Параметр | Описание |
|---|---|
id | ID счета в формате UUID |
uid | ID счета (для покупателя) |
projectId | ID проекта в формате UUID |
createDatetime | Дата и время создания счета (UTC) |
timeToPayDatetime | Дата и время, до которого действителен счет (UTC). До этой даты покупатель должен успеть оплатить счет |
commissionFiatUSD | Сумма комиссии сервиса. Рассчитывается относительно суммы amountFiatUSD |
amountFiatUSD | Сумма счета, приведенная к USD. При создании счета рассчитывается по текущему курсу относительно суммы amountFiat. В момент оплаты перезаписывается фактически поступившей суммой, приведенной к USD по курсу на этот момент. От нее же пересчитывается комиссия в commissionFiatUSD |
amountFiat | Оригинальная сумма счета в фиатной валюте. Не меняется |
currencyFiat | Валюта фиата |
description | Описание, которое было задано при создании счета. Отображается покупателю |
serviceData | Служебные данные, которые были заданы при создании счета. Не отображается покупателю. Служит для идентификации счета и платежа в магазине продавца |
views | Количество просмотров платежной страницы |
status | Статус счета |
payment | Раздел, содержащий параметры платежа. Отображается в случае, если счет был оплачен |
payment.id | ID платежа в формате UUID |
payment.amount | Сумма платежа в криптовалюте |
payment.hash | Хэш транзакции в блокчейне |
payment.transactionDatetime | Дата и время транзакции в блокчейне (UTC) |
wallet | Раздел, содержащий параметры кошелька, на который пришла оплата. Отображается в случае, если счет был оплачен |
wallet.id | ID кошелька в формате UUID |
wallet.name | Название кошелька |
wallet.blockchain | Блокчейн крипто кошелька |
wallet.cryptocurrency | Криптовалюта кошелька |
wallet.address | Адрес крипто кошелька |