Запрос баланса контрагента (balance)

Запрос balance возвращает разницу между суммой обеспечения, которую контрагент перечислил на счет шлюза в Яндекс.Деньгах, и суммой, которую Яндекс.Деньги зачислили в кошельки пользователей по запросам контрагента.

Шаблон адреса операций
https://server:port/webservice/deposition/api/balance

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

Параметры запроса

Параметр

Тип

Описание

clientOrderIdClientTransactionNumber

Идентификатор операции. Должен быть уникальным для контрагента на протяжении всей истории операций. Рекомендуемые значения: целое положительное число в десятичной системе счисления.

requestDTxs:dateTime

Дата и время формирования запроса операции на стороне и по часам контрагента.

agentIdxs:long

Идентификатор контрагента. Выдается Яндекс.Деньгами

Параметр

Тип

Описание

clientOrderIdClientTransactionNumber

Идентификатор операции. Должен быть уникальным для контрагента на протяжении всей истории операций. Рекомендуемые значения: целое положительное число в десятичной системе счисления.

requestDTxs:dateTime

Дата и время формирования запроса операции на стороне и по часам контрагента.

agentIdxs:long

Идентификатор контрагента. Выдается Яндекс.Деньгами

Пример запроса
<balanceRequest agentId="123"
                clientOrderId="12345"
                requestDT="2011-07-01T20:38:00.000Z"/>

Формат ответа

Параметры ответа

Параметр

Тип

Описание

statusxs:int

Результат выполнения операции. По значению этого поля контрагент принимает решение о состоянии запроса. См. Коды состояний запроса

errorxs:int

Код ошибки выполнения запроса. Является дополнительной расшифровкой к полю status. При успешной операции поле не передается.

clientOrderIdClientTransactionNumber

Копия параметра clientOrderId из запроса.

processedDTxs:dateTime

Время обработки запроса по часам сервера Яндекс.Денег.

balancexs:decimal

Разница между суммой, которую Яндекс.Деньги зачислили на кошельки по запросам контрагента и суммой, которую контрагент перечислил на счет шлюза в Яндекс.Деньгах.

Параметр

Тип

Описание

statusxs:int

Результат выполнения операции. По значению этого поля контрагент принимает решение о состоянии запроса. См. Коды состояний запроса

errorxs:int

Код ошибки выполнения запроса. Является дополнительной расшифровкой к полю status. При успешной операции поле не передается.

clientOrderIdClientTransactionNumber

Копия параметра clientOrderId из запроса.

processedDTxs:dateTime

Время обработки запроса по часам сервера Яндекс.Денег.

balancexs:decimal

Разница между суммой, которую Яндекс.Деньги зачислили на кошельки по запросам контрагента и суммой, которую контрагент перечислил на счет шлюза в Яндекс.Деньгах.

Пример ответа
<balanceResponse clientOrderId="12345"
                 status="0"
                 processedDT="2011-07-01T20:38:01.000Z"
                 balance="1000.00"/>

Смотрите также

Коды состояний запроса

Коды ошибок

Типы данных