Optima2 API v.2 REST

history

request

GET /api/v2/balance/history?startOn=2025-09-23 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" : [ ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 10,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : true,
  "totalElements" : 0,
  "totalPages" : 0,
  "first" : true,
  "size" : 10,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 0,
  "empty" : true
}

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" : 0.75,
  "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