Balance
history
request
GET /api/v2/balance/history?startOn=2025-05-29 HTTP/1.1
Parameter | Description |
---|---|
|
Required start date for period |
|
Not required finish date for period |
|
Not required operation type from there |
response
HTTP/1.1 200 OK
{
"content" : [ {
"id" : 135,
"user" : null,
"sum" : -3.15,
"comment" : "Уведомление для клиента Musk E. R.",
"balanceBefore" : 5000.0,
"balanceAfter" : 4996.85,
"date" : "2025-08-27T07:11:50.732Z",
"operation" : "SMS уведомление"
}, {
"id" : 136,
"user" : null,
"sum" : -1000.0,
"comment" : "Уведомление для клиента Тестов Т.",
"balanceBefore" : 10000.0,
"balanceAfter" : 9000.0,
"date" : "2025-08-27T07:14:26.821Z",
"operation" : "Email уведомление"
}, {
"id" : 137,
"user" : null,
"sum" : -3.15,
"comment" : "Уведомление для клиента Тестов Т.",
"balanceBefore" : 10000.0,
"balanceAfter" : 9996.85,
"date" : "2025-08-27T07:14:26.821Z",
"operation" : "SMS уведомление"
}, {
"id" : 138,
"user" : null,
"sum" : -1000.0,
"comment" : "Уведомление для клиента Тестов Т.",
"balanceBefore" : 10000.0,
"balanceAfter" : 9000.0,
"date" : "2025-08-27T07:14:28.056Z",
"operation" : "Email уведомление"
}, {
"id" : 139,
"user" : null,
"sum" : -3.15,
"comment" : "Уведомление для клиента Тестов Т.",
"balanceBefore" : 10000.0,
"balanceAfter" : 9996.85,
"date" : "2025-08-27T07:14:28.058Z",
"operation" : "SMS уведомление"
} ],
"pageable" : {
"pageNumber" : 0,
"pageSize" : 10,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"offset" : 0,
"paged" : true,
"unpaged" : false
},
"last" : true,
"totalElements" : 5,
"totalPages" : 1,
"first" : true,
"size" : 10,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"numberOfElements" : 5,
"empty" : false
}
Path | Type | Description |
---|---|---|
|
|
An array of balance flow |
|
|
id |
|
|
date |
|
|
user |
|
|
operation |
|
|
sum |
|
|
comment |
|
|
balanceBefore |
|
|
balanceAfter |
balance
request
GET /api/v2/balance HTTP/1.1
response
HTTP/1.1 200 OK
{
"balance" : 9996.85,
"minBalance" : 1000.0,
"currency" : "RUB"
}
Path | Type | Description |
---|---|---|
|
|
balance |
|
|
minBalance |
|
|
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" : "Перерасчёт стоимости"
}
Path | Type | Description |
---|---|---|
|
|
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
}
Path | Type | Description |
---|---|---|
|
|
enoughMoneyForNotification |