Balance

history

request
GET /api/v2/balance/history?startOn=2025-07-22 HTTP/1.1
Table 13. request description
Parameter Description

startOn

Required start date for period

finishOn

Not required finish date for period

operation

Not required operation type from there

response
HTTP/1.1 200 OK

{
  "content" : [ {
    "id" : 92,
    "user" : null,
    "sum" : -3.15,
    "comment" : "Рассылка номер 1000000310",
    "balanceBefore" : 1000.0,
    "balanceAfter" : 996.85,
    "date" : "2025-10-20T17:39:19.087Z",
    "operation" : "Рассылка SMS"
  }, {
    "id" : 93,
    "user" : null,
    "sum" : -3.15,
    "comment" : "Рассылка номер 1000000311",
    "balanceBefore" : 996.85,
    "balanceAfter" : 993.7,
    "date" : "2025-10-20T17:39:19.434Z",
    "operation" : "Рассылка SMS"
  }, {
    "id" : 94,
    "user" : null,
    "sum" : -3.15,
    "comment" : "Рассылка номер 1000000312",
    "balanceBefore" : 993.7,
    "balanceAfter" : 990.55,
    "date" : "2025-10-20T17:39:19.813Z",
    "operation" : "Рассылка SMS"
  }, {
    "id" : 95,
    "user" : null,
    "sum" : 0.0,
    "comment" : "Рассылка номер 1000000313",
    "balanceBefore" : 990.55,
    "balanceAfter" : 990.55,
    "date" : "2025-10-20T17:39:20.056Z",
    "operation" : "Рассылка SMS"
  }, {
    "id" : 96,
    "user" : null,
    "sum" : 0.0,
    "comment" : "Рассылка номер 1000000314",
    "balanceBefore" : 990.55,
    "balanceAfter" : 990.55,
    "date" : "2025-10-20T17:39:20.465Z",
    "operation" : "Рассылка SMS"
  }, {
    "id" : 97,
    "user" : null,
    "sum" : 0.0,
    "comment" : "Рассылка номер 1000000315",
    "balanceBefore" : 990.55,
    "balanceAfter" : 990.55,
    "date" : "2025-10-20T17:39:20.950Z",
    "operation" : "Рассылка email"
  } ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 10,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 6,
  "totalPages" : 1,
  "first" : true,
  "size" : 10,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 6,
  "empty" : false
}
Table 14. response description
Path Type Description

content[].

Array

An array of balance flow

[].id

String

id

[].date

String

date

[].user

String

user

[].operation

String

operation

[].sum

String

sum

[].comment

String

comment

[].balanceBefore

String

balanceBefore

[].balanceAfter

String

balanceAfter

balance

request
GET /api/v2/balance HTTP/1.1
response
HTTP/1.1 200 OK

{
  "balance" : 1000.0,
  "minBalance" : 1000.0,
  "currency" : "RUB"
}
Table 15. response description
Path Type Description

balance

Number

balance

minBalance

Number

minBalance

currency

String

currency

operation types

request
GET /api/v2/balance/operations HTTP/1.1
response
HTTP/1.1 200 OK

{
  "VK_COLLECT_AGREEMENT" : "Сбор согласия на обработку данных через ВКонтакте",
  "CASH_IN" : "Пополнение баланса",
  "RETURN" : "Возврат денег",
  "MAILING_RETURN" : "Возрат средств после остановки рассылки",
  "SMS" : "Рассылка SMS",
  "EMAIL_COLLECT_AGREEMENT" : "Сбор согласия на обработку данных через email",
  "SMS_NOTIFICATION" : "SMS уведомление",
  "SMS_COLLECT_AGREEMENT" : "Сбор согласия на обработку данных через СМС",
  "EMAIL_NOTIFICATION" : "Email уведомление",
  "EMAIL" : "Рассылка email",
  "RECALCULATE_PRICE" : "Перерасчёт стоимости"
}
Table 16. response description
Path Type Description

operationTypes

Array

Map of operation type

enough money for notification

request
GET /api/v2/balance/enough-money-for-notification HTTP/1.1
response
HTTP/1.1 200 OK

{
  "enoughForEmail" : false,
  "enoughForSms" : false,
  "enoughForVk" : false
}
Table 17. response description
Path Type Description

enoughMoneyForNotification

Boolean

enoughMoneyForNotification