Запрос balance возвращает разницу между суммой, которую контрагент выплатил своим клиентам, и суммой, которую контрагент перечислил на номер баланса выплат.
Адрес для отправки запросов
https://payouts.yookassa.ru:9094/webservice/deposition/api/balance
| Параметр | Тип | Описание |
|---|---|---|
| clientOrderId | ClientTransactionNumber | Идентификатор операции. Должен быть уникальным для контрагента на протяжении всей истории операций. Рекомендуемые значения: целое положительное число в десятичной системе счисления. |
| requestDT | xs:dateTime | Дата и время формирования запроса операции на стороне и по часам контрагента. |
| agentId | xs:long | Идентификатор контрагента. Выдается ЮKassa |
XML
<balanceRequest agentId="123" clientOrderId="12345" requestDT="2011-07-01T20:38:00.000Z"/>
| Параметр | Тип | Описание |
|---|---|---|
| status | xs:int | Результат выполнения операции. По значению этого поля контрагент принимает решение о состоянии запроса. См. Коды состояний запроса |
| error | xs:int | Код ошибки выполнения запроса. Является дополнительной расшифровкой к полю status.
При успешной операции поле не передается. |
| clientOrderId | ClientTransactionNumber | Значение параметра clientOrderId из запроса. Отсутствует в ответе, если не удалось разобрать запрос
(коды ошибок 10, 50, 51, 53, 55) или если
в запросе параметр clientOrderId отсутствует или неверно задан (error=18). |
| processedDT | xs:dateTime | Время обработки запроса по часам сервера ЮKassa. |
| balance | xs:decimal | Разница между суммой обеспечения, которую контрагент перечислил на счет шлюза в ЮKassa, и суммой, которую ЮKassa перечислили пользователям по запросам контрагента. |
XML
<balanceResponse clientOrderId="12345" status="0" processedDT="2011-07-01T20:38:01.000Z" balance="1000.00"/>