Request counterparty's balance (balance)

The balance request returns the difference between the security amount that the Counterparty deposited to the gateway account in Yandex.Money and the amount that Yandex.Money has transferred to user Wallets on request of the Counterparty.

Pattern for operation addresses
https://server:port/webservice/deposition/api/balance

Request format

Request parameters

Parameter

Type

Description

clientOrderId ClientTransactionNumber

Operation ID. Must be unique for the Counterparty over the entire history of operations. Recommended values: a positive integer in decimal notation.

requestDT xs:dateTime

The date and time the operation request was formed on the Counterparty's side, according to their system.

agentId xs:long

Counterparty ID. Issued by Yandex.Money

Request example
<balanceRequest agentId="123"
                clientOrderId="12345"
                requestDT="2011-07-01T20:38:00.000Z"/>

Response format

Response parameters

Parameter

Type

Description

status xs:int

Result of executing the operation. The Counterparty uses the value of this field to make a decision about the request state. See Codes of request states.

error xs:int

Code of the request execution error. Provides an additional explanation of the status field. For a successful operation, this field is omitted.

clientOrderId ClientTransactionNumber

A copy of the clientOrderId parameter from the request.

processedDT xs:dateTime

Time when the request was processed, according to the Yandex.Money server.

balance xs:decimal

The difference between the amount that Yandex.Money transferred to Wallets at the Counterparty's request and the amount that the Counterparty deposited to the gateway account in Yandex.Money.

Response example
<balanceResponse clientOrderId="12345"
                 status="0"
                 processedDT="2011-07-01T20:38:01.000Z"
                 balance="1000.00"/>

See also

Request status codes

Error codes

Data types