Запрос баланса (balance)

Это старая версия API. Переходите на API ЮKassa.

С помощью запроса balance вы можете узнать баланс вашего шлюза в ЮKassa. В ответ на запрос вернется разница между суммой, которую вы выплатили своим клиентам, и суммой, которую вы перечислили на баланс шлюза.

Формат запроса

Адрес для отправки запросов

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"/>

Что почитать еще

Тестирование Реестры успешных и возвращенных выплат