Статистика

Чтобы получить статистику вашего аккаунта, отправьте POST запрос на следующий URL:

Статистика платежей за период

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

Отправив этот запрос, вы получите статистику по счетам за указанный период.

Request Body

Name
Type
Description

start*

String

Дата в формате "dd.mm.yyyy"

end*

String

Дата в формате "dd.mm.yyyy"

{
    "status": "success",
    "result": {
        "count": {
            "all": 59,
            "created": 41,
            "paid": 16,
            "overpaid": 1,
            "partial": 1,
            "canceled": 0
        },
        "amount": {
            "all": 4683.83,
            "created": 3032.63,
            "paid": 1531.0,
            "overpaid": 100.2,
            "partial": 20.0,
            "canceled": 0
        }
    }
}

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

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

  • count — объект, в котором находятся значения по количеству счетов.

  • amount — объект, в котором находятся значения по суммам в USD.

  • all — все счета.

  • created — счета со статусом «Создан».

  • paid — счета со статусом «Оплачен».

  • overpaid — счета со статусом «Переплата».

  • partial — счета со статусом «Частично оплачен».

  • canceled — счета со статусом «Отменен».

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

Эти примеры показывают, как можно отправить запрос для получения статистики. Обратите внимание, что необходимо предоставить ваш API ключ в заголовке Authorization для успешной авторизации запроса.

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"}'

Last updated