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