Список счетов
Чтобы получить список всех счетов, отправьте POST запрос на следующий URL:
Список счетов
POST
https://api.cryptocloud.plus/v2/invoice/merchant/list
При отправке данного запроса вы получите список счетов за указанный период. Максимальное количество записей за один запрос — 100. По умолчанию в ответе будет 10 записей.
Request Body
Name | Type | Description |
---|---|---|
start* | String | Дата в формате "dd.mm.yyyy" |
end* | String | Дата в формате "dd.mm.yyyy". Должна быть больше или равна start |
offset | Int | Это номер начальной записи, с которой начнется вывод данных. Например, если установить |
limit | Int | Это номер последней записи, которую вы хотите получить. Например, если |
Описание параметров
Название параметра | Тип данных | Описание | Пример |
---|---|---|---|
start | String | Дата в формате "dd.mm.yyyy" | 01.01.2023 |
end | String | Дата в формате "dd.mm.yyyy" | 31.01.2023 |
offset | Int | Это номер начальной записи, с которой начнется вывод данных. Например, если установить | 0 |
limit | Int | Это номер последней записи, которую вы хотите получить. Например, если | 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
для успешной авторизации запроса.
Last updated