Список счетов
Чтобы получить список всех счетов, отправьте POST запрос на следующий URL:
Список счетов
POST
https://api.cryptocloud.plus/v2/invoice/merchant/list
При отправке данного запроса вы получите список счетов за указанный период. Максимальное количество записей за один запрос — 100. По умолчанию в ответе будет 10 записей.
Request Body
start*
String
Дата в формате "dd.mm.yyyy"
end*
String
Дата в формате "dd.mm.yyyy". Должна быть больше или равна start
offset
Int
Это номер начальной записи, с которой начнется вывод данных. Например, если установить offset=10
, то данные начнут показываться с 11-й записи
limit
Int
Это номер последней записи, которую вы хотите получить. Например, если limit=20
, то вы получите записи до 20-й включительно, начиная с той, что указана в offset
{
"status": "success",
"result": [
{
"uuid": "INV-XXXXXXXX",
"created": "2023-01-01 12:00:00.000000",
"address": "",
"currency": {
"id": 4,
"code": "USDT",
"fullcode": "USDT_TRC20",
"network": {
"code": "TRC20",
"id": 4,
"icon": "https://cdn.cryptocloud.plus/currency/crypto/TRX.svg",
"fullname": "Tron"
},
"name": "Tether",
"is_email_required": false,
"stablecoin": true,
"icon_base": "https://cdn.cryptocloud.plus/currency/icons/main/usdt.svg",
"icon_network": "https://cdn.cryptocloud.plus/icons-currency/USDT-TRC20.svg",
"icon_qr": "https://cdn.cryptocloud.plus/currency/icons/stroke/usdt.svg",
"order": 1
},
"date_finished": null,
"expiry_date": "2023-01-02 12:00:00",
"side_commission": "client",
"side_commission_cc": "merchant",
"type_payments": "crypto",
"status": "created",
"is_email_required": false,
"project": {
"id": 1,
"name": "My store",
"fail": "https://test.com/fail?order_id=1111&invoice_uuid=INV-XXXXXXXX",
"success": "https://test.com/success?order_id=1111&invoice_uuid=INV-XXXXXXXX",
"logo": "None"
},
"tx_list": [],
"test_mode": false,
"type": "up",
"user_email": "",
"pay_url": "None",
"phone": "",
"order_id": "1111",
"amount_in_crypto": null,
"amount_in_fiat": 100,
"amount": 100.0,
"amount_usd": 100.0,
"amount_to_pay": 101.4,
"amount_to_pay_usd": 101.4,
"amount_paid": 0.0,
"amount_paid_usd": 0.0,
"fee": 1.4,
"fee_usd": 1.4,
"service_fee": 0,
"service_fee_usd": 1.9,
"received": 0.0,
"received_usd": 0.0,
"to_surcharge": 0.0,
"to_surcharge_usd": 0.0
},
{...},
{...},
{...},
{...},
{...},
],
"all_count": 100
}
Описание параметров
start
String
Дата в формате "dd.mm.yyyy"
01.01.2023
end
String
Дата в формате "dd.mm.yyyy"
31.01.2023
offset
Int
Это номер начальной записи, с которой начнется вывод данных. Например, если установить offset=10
, то данные начнут показываться с 11-й записи. Значение по умолчанию 0
0
limit
Int
Это номер последней записи, которую вы хотите получить. Например, если limit=20
, то вы получите записи до 20-й включительно, начиная с той, что указана в offset
. Значение по умолчанию 10
10
Описание параметров ответа
На успешный запрос приходит ответ со статусом success и объектом result.
uuid — уникальный идентификатор счета с префиксом INV.
created — время создания счета по UTC +0 в формате YYYY-MM-DD HH:MI:SS.FFFFFF.
address — адрес для оплаты. Будет предзаполнен только в случае выбора криптовалюты для оплаты. Для выбора валюты за клиента необходимо в add_fields.cryptocurrency указать доступную в проекте валюту.
expiry_date — дата истечения срока действия счета по UTC +0 в формате YYYY-MM-DD HH:MI:SS.FFFFFF. После истечения срока действия счет переведется в статус canceled, если оплата не поступила.
side_commission — сторона оплаты трансферной комиссии.
side_commission_сс — сторона оплаты комиссии сервиса.
amount — сумма счета.
amount_usd — сумма счета в USD.
amount_in_fiat — сумма счета в валюте создания (зависит от параметра currency).
fee — трансферная комиссия счета.
fee_usd — трансферная комиссия счета в USD.
service_fee — комиссия сервиса.
service_fee_usd — комиссия сервиса в USD.
fiat_currency — код фиатной валюты, в которой был создан счет.
status — статус счета. При отправке запроса на создание счета всегда равен created. Так же есть статусы paid (оплачен), partial (оплачен частично), overpaid (переплачен) и canceled (отменен).
is_email_required — параметр для обязательного заполнения почты в счете.
link — ссылка на страницу счета.
currency — объект выбранной криптовалюты в счете. Так же содержит объект network — информация о выбранной сети валюты.
project — объект с информацией о проекте.
test_mode — признак тестового счета.
received — зачисленная на баланс сумма в криптовалюте.
received_usd — зачисленная на баланс сумма в USD.
to_surcharge — сумма к доплате в криптовалюте.
to_surcharge_usd — сумма к доплате в USD.
Примеры запросов
Эти примеры показывают, как можно отправить запрос для отмена счета. Обратите внимание, что необходимо предоставить ваш API ключ в заголовке Authorization
для успешной авторизации запроса.
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}'
Мы регулярно работаем над улучшением документации сервиса для разработчиков. Пожалуйста, оцените качество и полезность материалов по ссылке.
Last updated
Was this helpful?