API Виджета СБП
Скачать спецификацию OpenAPIФайл может быть использован как для ознакомления с методами API, так и для генерации базового кода для работы с API на удобном языке программирования с помощью утилиты Swagger Codegen или онлайн-сервиса Swagger Editor.
Общая информация
API получения списков: – Участников СБП (Банков Плательщика) – Участников платформы Цифровой рубль для формирования виджета на стороне Банка или Агента ТСП. Сокращения: СБП – Система Быстрых Платежей ЦР – Цифровой Рубль Банка России
Методы
Список Участников СБП по Payload (v1)
Метод для получения полного списка Участников СБП (Банков Плательщика) по операциям C2B, C2G, B2B или С2С, и формирования Виджета СБП на стороне Участника СБП – Банка Получателя или Агента ТСП, или ТСП.
HEADER PARAMETERS
https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=10000&cur=RUB&crc=C08BОтветы
200Успешный ответ
{ version: string enum enum: 1.0 platform: string enum enum: ios | android | desktop type: string enum enum: qr | sub | b2b | c2g | c2c | b2c members: [{ name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "1.0",
"platform": "desktop",
"type": "qr",
"members": [
{
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/AS100001ORTF4GAF80KPJ53K186D9A3G?type=01&bank=100000000001&sum=20000&cur=RUB&crc=5798"
}
]
}{
"message": "Не передан заголовок X-CLIENT"
}{
"message": "Неправильная платформа, тип платежа или QR код"
}Список Участников СБП по Payload (v2)
Метод для получения полного списка Участников СБП (Банков Плательщика) по операциям C2B, C2G, B2B или С2С, и формирования Виджета СБП на стороне Участника СБП – Банка Получателя или Агента ТСП, или ТСП.
HEADER PARAMETERS
https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=10000&cur=RUB&crc=C08BОтветы
200Успешный ответ
{ version: string enum enum: 2.0 platform: string enum enum: ios | android | desktop type: string enum enum: qr | sub | b2b | c2g | c2c | b2c members: [{ id: string [12] name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "2.0",
"platform": "desktop",
"type": "qr",
"members": [
{
"id": "100000000001",
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/AS100001ORTF4GAF80KPJ53K186D9A3G?type=01&bank=100000000001&sum=20000&cur=RUB&crc=5798"
}
]
}{
"message": "Не передан заголовок X-CLIENT-ID"
}{
"message": "Неправильная платформа, тип платежа или QR код"
}Список Участников СБП для кэширования (v1)
Метод для получения списка Участников СБП – Банков Плательщика для кэширования на срок не более чем 24 часа. Метод возвращает шаблоны прямой или доменной ссылки для перехода в приложение Банка Плательщика. Шаблоны передаются для каждого Банка Плательщика в параметре URL. Пример: «bank100000000000//qr.nspk.ru/{QRC_ID}{QUERY_STRING}». При формировании Прямой или Доменной ссылки необходимо самостоятельно подставлять в шаблон URL данные из Функциональной ссылки СБП вместо {QRC_ID} и {QUERY_STRING}. Если ссылка не содержит параметров запроса вместо {QUERY_STRING} подставляется пустая строка.
PATH PARAMETERS
HEADER PARAMETERS
Ответы
200Успешный ответ
{ version: string enum enum: 1.0 platform: string enum enum: ios | android | desktop type: string enum enum: qr | sub | b2b | c2g | c2c | b2c members: [{ name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "1.0",
"platform": "desktop",
"type": "qr",
"members": [
{
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/{QRC_ID}{QUERY_STRING}"
}
]
}{
"message": "Не передан заголовок X-CLIENT"
}{
"message": "Неправильная платформа или тип платежа"
}Список Участников СБП для кэширования (v2)
Метод для получения списка Участников СБП – Банков Плательщика для кэширования на срок не более чем 24 часа. Метод возвращает шаблоны прямой или доменной ссылки для перехода в приложение Банка Плательщика. Шаблоны передаются для каждого Банка Плательщика в параметре URL. Пример: «bank100000000000//qr.nspk.ru/{QRC_ID}{QUERY_STRING}». При формировании Прямой или Доменной ссылки необходимо самостоятельно подставлять в шаблон URL данные из Функциональной ссылки СБП вместо {QRC_ID} и {QUERY_STRING}. Если ссылка не содержит параметров запроса вместо {QUERY_STRING} подставляется пустая строка.
PATH PARAMETERS
HEADER PARAMETERS
Ответы
200Успешный ответ
{ version: string enum enum: 2.0 platform: string enum enum: ios | android | desktop type: string enum enum: qr | sub | b2b | c2g | c2c | b2c members: [{ id: string [12] name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "2.0",
"platform": "desktop",
"type": "qr",
"members": [
{
"id": "100000000001",
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/{QRC_ID}{QUERY_STRING}"
}
]
}{
"message": "Не передан заголовок X-CLIENT-ID"
}{
"message": "Неправильная платформа или тип платежа"
}Список участников платформы ЦР по Payload (v2)
Метод для получения полного списка Участников платформы ЦР и формирования Виджета СБП на стороне Участника СБП – Банка Получателя или Агента ТСП, или ТСП.
HEADER PARAMETERS
https://qr.nspk.ru/AS1000670LSS7DN18SJQDNP4B05KLJL2?type=01&bank=100000000001&sum=10000&cur=RUB&crc=C08BОтветы
200Успешный ответ
{ version: string enum enum: 2.0 platform: string enum enum: ios | android | desktop members: [{ id: string [12] name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "2.0",
"platform": "desktop",
"members": [
{
"id": "100000000001",
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/AS100001ORTF4GAF80KPJ53K186D9A3G?type=01&bank=100000000001&sum=20000&cur=RUB&crc=5798"
}
]
}{
"message": "Не передан заголовок X-CLIENT-ID"
}{
"message": "Неправильная платформа, тип платежа или QR код"
}Список участников платформы ЦР для кэширования (v2)
Метод для получения списка Участников платформы ЦР – Банков Плательщика для кэширования на срок не более чем 24 часа. Метод возвращает шаблоны прямой или доменной ссылки для перехода в приложение Банка Плательщика. Шаблоны передаются для каждого Банка Плательщика в параметре URL. Пример: «bank100000000000//qr.nspk.ru/{QRC_ID}{QUERY_STRING}». При формировании Прямой или Доменной ссылки необходимо самостоятельно подставлять в шаблон URL данные из Функциональной ссылки СБП вместо {QRC_ID} и {QUERY_STRING}. Если ссылка не содержит параметров запроса вместо {QUERY_STRING} подставляется пустая строка.
HEADER PARAMETERS
Ответы
200Успешный ответ
{ version: string enum enum: 2.0 platform: string enum enum: ios | android | desktop members: [{ id: string [12] name: string logo: string url: string }]}400Некорректный запрос
{ message: string}404Данные не найдены
{ message: string}Примеры ответов
{
"version": "2.0",
"platform": "desktop",
"members": [
{
"id": "100000000001",
"name": "Банк",
"logo": "https://qr.nspk.ru/proxyapp/logo/bank000000000001.png",
"url": "bank000000000001://qr.nspk.ru/{QRC_ID}{QUERY_STRING}"
}
]
}{
"message": "Не передан заголовок X-CLIENT-ID"
}{
"message": "Неправильная платформа или тип платежа"
}