webapi/sbp/SBPCreditBalance - Баланс счета ТСП для СБП выплаты

HTTP‑методы: POST
URL: /webapi/sbp/SBPCreditBalance/
Форма взаимодействия: Сервер-сервер
Формат тела запроса: application/x-www-form-urlencoded
Назначение: получение информации о доступном балансе на счету сектора.

URL

URLPATH

https://b2p.wallet.kvell.group/webapi/sbp/SBPCreditBalance/

/webapi/sbp/SBPCreditBalance/

Структура запроса

Поле	Тип	Обяз.	Описание
`sector`	`str`	✔	Уникальный идентификатор учётной записи ТСП в ПЦ.
`nonce`	`int`	✔	Уникальный номер Запроса.
`signature`	`str`	✔	Цифровая подпись (`sector`, `nonce`, `password`)

Структура ответа

Элемент	Тип	Описание
`nonce`	`int`	Значение nonce из запроса.
`account`	`account`	Список счетов.
`signature`	`str`	Цифровая подпись сообщения. В подписи участвуют значения всех тегов в порядке их следования и пароль для расчёта цифровой подписи, предоставляемый ТСП после его регистрации в ПЦ.

Каждый account включает:

Элемент	Тип	Описание
`id`	`int`	Идентификатор счета
`bank`	`str`	Банк счета.
`amount`	`int`	Сумма остатка на счету в минимальных единицах валюты (для RUB — копейки).
`account_details`	`account_details`	Дополнительная информация по счету

Объект account_details включает:

Элемент	Тип	Описание
`curency`	`int`	Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD).
`status`	`str`	Статус активности счета.

Пример ответов

Успех (200)Ошибка валидации (400)

<?xml version="1.0" encoding="UTF-8"?>
<SBPCreditBalance>
    <nonce>10</nonce>
    <account>
        <id>*1234567</id>
        <bank>sbp-credit-random-bank</bank>
        <amount>6900</amount>
        <account_details>
            <currency>643</currency>
            <status>ACTIVE</status>
        </account_details>
        <error>string</error>
    </account>
</SBPCreditBalance>

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <description>Sector not found</description>
    <code>105</code>
</error>

Примечания

Ответ может содержать ряд новых необязательных параметров, которые важно учесть при составлении подписи.
Параметр nonce не учитывается в логике запроса и не проверяется на валидность последовательности.