Статистика

Метод позволяет получить статистику платежей с помощью отправки POST запроса.

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

• Возвращает статистику по статусам счетов за указанный период

Endpoint

POST https://api.cryptocloud.plus/v2/invoice/merchant/statistics

Headers

Name	Type	Example	Description
Authorization*	string	Token eyJ0eXAiOiJK<...>4npi1ksS8tSY	API-ключ проекта

Request Body

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

Name	Type	Example	Description
start*	string	01.01.2026	Дата в формате "dd.mm.yyyy"
end*	string	31.01.2026	Дата в формате "dd.mm.yyyy". Должна быть больше или равна start

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

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

cURL

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

Python

JavaScript

PHP

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

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

200: OK - statistics

{
    "status": "success",
    "result": {
        "count": {
            "all": 907,
            "created": 4,
            "paid": 90,
            "overpaid": 8,
            "partial": 6,
            "canceled": 799
        },
        "amount": {
            "all": 214356.22712,
            "created": 4.0,
            "paid": 629.729137,
            "overpaid": 36.82,
            "partial": 11.4,
            "canceled": 213674.277983
        }
    }
}

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

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

Name	Type	Example	Description
count	dict	"count": { "all": 907, "created": 4, "paid": 90, "overpaid": 8, "partial": 6, "canceled": 799 }	Объект, в котором находятся значения по количеству счетов
amount	dict	"amount": { "all": 214356.22712, "created": 4.0, "paid": 629.729137, "overpaid": 36.82, "partial": 11.4, "canceled": 213674.277983 }	Объект, в котором находятся значения по суммам в USD
all	int, float	907 / 214356.22712	Все счета
created	int, float	4 / 4.0	Счета со статусом «Создан».
paid	int, float	90 / 629.729137	Счета со статусом «Оплачен».
overpaid	int, float	8 / 36.82	Счета со статусом «Переплата».
partial	int, float	6 / 11.4	Счета со статусом «Частично оплачен».
canceled	int, float	799 / 213674.277983	Счета со статусом «Отменен».

Мы регулярно работаем над улучшением документации сервиса для разработчиков. Пожалуйста, оцените качество и полезность материалов по ссылке.