Balance request (balance)
The balance request returns the difference between the security amount that the Counterparty deposited to the gateway account in YooMoney and the amount that YooMoney has transferred to user Wallets on request of the Counterparty.
 
Request format
Address for sending requests
https://deposit.yoomoney.ru:9094/webservice/deposition/api/balance
Request parameters
ParameterTypeDescription
clientOrderIdClientTransactionNumberOperation ID. Must be unique for the Counterparty over the entire history of operations. Recommended values: a positive integer in decimal notation.
requestDTxs:dateTimeДата и время формирования запроса операции на стороне и по часам контрагента.
agentIdxs:longCounterparty ID. Issued by YooMoney
Request example
XML
<balanceRequest agentId="123"
                clientOrderId="12345"
                requestDT="2011-07-01T20:38:00.000Z"/>
Response format
Response parameters
ParameterTypeDescription
statusxs:intResult of executing the operation. The Counterparty uses the value of this field to make a decision about the request state. See Request status codes
error
xs:int
Code of the request execution error. Provides an additional explanation of the status field.
clientOrderIdClientTransactionNumberThe value of the clientOrderId request parameter. The parameter is omitted in the response if the request was not parsed (error codes 10, 50, 51, 53, 55) or if the clientOrderId request parameter is missing or invalid (error=18).
processedDTxs:dateTimeTime when the request was processed, according to the YooMoney server.
balancexs:decimalThe difference between the security amount that the Counterparty has transferred to the gateway account in YooMoney, and the amount of money that YooMoney has transferred to users at the request of the Counterparty.
Example of the response
XML
<balanceResponse clientOrderId="12345"
                 status="0"
                 processedDT="2011-07-01T20:38:01.000Z"
                 balance="1000.00"/>
See also
Testing Reports on accepted and returned transfers