Перейти к содержанию

api/sbp/sbp-credit-balance - Баланс счета ТСП для СБП выплат

  • HTTP‑методы: POST
  • URL: /api/sbp/sbp-credit-balance
  • Форма взаимодействия: Сервер-сервер
  • Формат тела запроса: application/json
  • Назначение: получение информации о доступном балансе на счету терминала.

URL

1
https://gateway-docs.wallet.kvell.group/api/sbp/sbp-credit-balance

1
/api/sbp/sbp-credit-balance

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

Поле Тип Обяз. Описание
terminal str ✔ Уникальный идентификатор учетной записи ТСП в ПЦ.
nonce int ✔ Уникальный номер Запроса. Каждый очередной Запрос должен иметь значение параметра nonce не меньшее, чем в предыдущем Запросе.
signature str ✔ Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.

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

Поле Тип Обяз. Описание
nonce int ✔ Значение nonce из запроса. Пример: 10
accounts list[AccountResponseDTO] Список счетов (см. ниже).

Вложенный объект accounts[] (AccountResponseDTO)

Поле Тип Обяз. Описание
account_id str ✔ Идентификатор счета. Пример: *1234567
bank str ✔ Банк счета. Пример: sbp-credit-random-bank
amount int Сумма остатка на счету в минимальных единицах валюты (для RUB — копейки). Пример: 6900
account_details AccountDetailsResponseDTO Дополнительная информация по счету (см. ниже).
error ErrorResponseDTO Информация об ошибке по данному счету, если она возникла (см. ниже).

Вложенный объект account_details (AccountDetailsResponseDTO)

Поле Тип Обяз. Описание
currency int ✔ Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). Пример: 643
status str Статус активности счета. Пример: Активен

Вложенный объект error (ErrorResponseDTO)

Поле Тип Обяз. Описание
description str ✔ Описание ошибки по счету. Пример: Ошибка: Некорректный номер расчетного счета
code int ✔ Код ошибки. Пример: 219

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

{
    "nonce": 10,
    "accounts": [
        {
            "account_id": "*1234567",
            "bank": "sbp-credit-random-bank",
            "amount": 6900,
            "account_details": {
                "currency": 643,
                "status": "Активен"
            },
            "error": null
        }
    ]
}

{
    "error_code": "TERMINAL_NOT_FOUND",
    "technical_message": "Terminal not found",
    "timestamp": 1751976000,
    "details": null,
    "request_id": "b3b3c1f0-4b3a-4f3a-9b1a-1234567890ab"
}

Примечания

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