Raiff logo
API docs by Redocly

API интеграции Системы быстрых платежей (СБП) для B2B (0.1)

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

Подключение к СБП

Для приёма и / или отправки СБП-платежей оставьте заявку в РБО → Продукты → В2В-платежи по СБП.

Райффайзенбанк выполнит регистрацию. После завершения процесса вы будете оповещены по электронной почте.

Общие схемы работы

Схема работы заказа

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

Схема работы по многоразовым Qr

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

Авторизация

Для авторизация запросов необходимы:

  • secretKey - секретный ключ, который используется для межсервисного взаимодействия.

Тестовый хост: https://pay-test.raif.ru

Продуктовый хост: https://pay.raif.ru

BАЖНО: Секретный ключ необходимо хранить в защищённом месте, нельзя публиковать на сторонних ресурсах или передавать третьим лицам.

Межсервисные запросы авторизуются посредством секретного ключа API (SECRET_KEY). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer SECRET_KEY".

Посмотреть боевой publicId и сгенерировать ключи можно в РБО → Прием платежей → Настройки.

Для генерации тестового секретного ключа необходимо обратиться по адресу: ecom@raiffeisen.ru

Тестирование СБП

Для получения тестовых данных для интеграции напишите на ecom@raiffeisen.ru. В ответном письме мы отправим вам токен для авторизации в тестовой среде и два счёта для тестирования сервиса.

Ниже представлены запросы ТОЛЬКО для тестового окружения, запросы для продуктового окружения описаны тут

Также для тестовой платы можно использовать R-Future со сканированием qr. Для оплаты методом сканирования нужно открыть ссылку imageUrl(в ответе на создание qr) или перейти по адресу https://pay-test.raif.ru/api/b2b/sbp/v1/qrs/{qrId}/image - появится изображение QR Далее открыть https://pay-test.raif.ru/pay/rfuture/# нажать кнопку "Сканировать QR", навести камеру и появится форма оплаты, по которой можно произвести платеж.

Создание тестовой оплаты

!! Данные endpoint можно использовать только в ТЕСТОВОМ окружении !!

path Parameters
qrId
required
string

Уникальный идентификатор платёжной ссылки

Request Body schema: application/json
required
amount
required
number <float> (Amount) <= 1000000

Сумма операции в рублях

Responses

Request samples

Content type
application/json
{
  • "amount": 8573.79
}

Response samples

Content type
application/json
{
  • "code": "INVALID_DATA",
  • "message": "Некорректные данные"
}

Заказы

Генерация изображения платёжной ссылки

path Parameters
qrId
required
string

Уникальный идентификатор платёжной ссылки

query Parameters
format
any
Enum: "SVG" "PNG"

Формат изображения

withLogo
boolean
Default: true

Отображение логотипа СБП в QR-коде

Responses

Получение данных заказа

Authorizations:
BearerAuth
path Parameters
id
required
string

Идентификатор заказа

Responses

Response samples

Content type
application/json
Example

Ответ на создание заказа без указаниям ограничений Отсутствует блок restrictions

{}

Отмена заказа

Метод позволяет отменить неоплаченный заказ. После отмены оплата заказа с текущим id будет недоступна. Но вы можете переиспользовать этот id для создания нового заказа

Authorizations:
BearerAuth
path Parameters
id
required
string

Идентификатор заказа

Responses

Response samples

Content type
application/json
{
  • "code": "FORBIDDEN",
  • "message": "Доступ запрещен"
}

Получение списка операций по многоразовым платежным ссылкам (не более 30 дней)

Authorizations:
BearerAuth
query Parameters
from
required
string <date-time>
Example: from=2025-06-15T04:31:17.604Z

Дата начала выборки

to
required
string <date-time>
Example: to=2025-06-19T04:31:17.604Z

Дата окончания выборки

ids
Array of strings[ items <= 5 items ]
Example: ids=123e4567-e89b-12d3-a456-426655440000

Идентификаторы многоразовых платежных ссылок

page
integer <int32>
Default: 1

Номер страницы

size
integer <int32>
Default: 20

Количество отображаемых операций

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalElements": 34,
  • "last": true
}

Разделение платежа (Сплитование)

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

Для управления счетами необходимо обратиться в тех. поддержку банка ecom@raiffeisen.ru.

Сценарий позволяет создавать и изменять заказы, регистрировать одноразовые (динамические) QR коды с распределением денежных средств на счета контрагентов.

Денежные средства распределяются на счета контрагентов на следующий день после совершения платежа. Всю сумму платежа можно зачислить как на один счет контрагента, так и на несколько счетов.

Создание заказа с сплитованием

Authorizations:
BearerAuth
Request Body schema: application/json
required
id
string

Идентификатор заказа, переданный клиентом или сгенерированный банком

name
string

Наименование платёжной ссылки

amount
required
number <float> <= 1000000

Сумма операции в рублях

totalTaxAmount
number or null <float> <= 1000000

Сумма НДС в рублях

expirationDate
string <yyyy-MM-ddTHH:mm:ss±HH:mm / +nM / +nm>

Срок жизни заказа
Может содержать точную дату и время или количество минут. Передача срока в минутах удобна для торговых точек, которые не привязываются к точному времени или часовому поясу
Параметр не может быть меньше текущей даты и времени. Если указывается в минутах, то не может быть меньше 1 минуты. Максимальное значение — 129600 минут (90 суток). Если параметр не передан, то по умолчанию QR будет действителен 4320 минут (3 суток)
После истечения срока действия заказа оплату по нему провести нельзя
При передачи количества минут указываете в таком виде (например, + 60 минут): "expirationDate": "+60m"

receiverPaymentPurpose
string <= 100 characters

Назначение платежа, которое будет отражено в реестре.
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и !, ", #, $, %, ', (, ), *, +, ,, -, ., /, :, ;, =, >, ?, @, [, \, ], ^, _, {, |, }, ~,№

senderPaymentPurpose
required
string <= 210 characters

Назначение платежа, которое увидит плательщик при оплате
Может содержать:
• Символы латиницы (A–Z и a–z)
• Символы кириллицы (А-Я и а-я)
• Цифры 0-9
• Спецсимволы: пробел и !, ", #, $, %, ', (, ), *, +, ,, -, ., /, :, ;, =, >, ?, @, [, \, ], ^, _, {, |, }, ~,№

redirectUrl
string <= 1024 characters

Ссылка для автоматического возврата плательщика из приложения банка в приложение или на сайт ТСП

required
Array of objects

Блок данных для работы со сплитованием

object

Дополнительные поля

object or null

Ограничения к заказу

Responses

Request samples

Content type
application/json
Example

Запрос на создание заказа c указанием количества минут жизни

{
  • "id": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "name": "QR на оплату 25.09.2024 в 15:12",
  • "amount": 7.45,
  • "totalTaxAmount": 1.25,
  • "expirationDate": "+60m",
  • "receiverPaymentPurpose": "Какое-то назначение платежа",
  • "senderPaymentPurpose": "Какое-то назначение платежа",
  • "redirectUrl": "https://example.ru",
  • "splits": [
    ],
  • "extra": {
    }
}

Response samples

Content type
application/json
Example

Ответ на создание заказа без указания ограничений Отсутствует блок restrictions

{
  • "id": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "account": "40817810601002630000",
  • "amount": 8573.79,
  • "totalTaxAmount": 2.41,
  • "creationDate": "2024-06-12T19:35:55+03:00",
  • "expirationDate": "2024-08-12T20:35:55+03:00",
  • "status": "ACTIVE",
  • "receiverPaymentPurpose": "Какое-то назначение платежа",
  • "senderPaymentPurpose": "Какое-то назначение платежа",
  • "redirectUrl": "https://exampletsp.io/qwertyui",
  • "splits": [
    ],
  • "extra": {
    },
  • "qr": {}
}

Генерация изображения платёжной ссылки

path Parameters
qrId
required
string

Уникальный идентификатор платёжной ссылки

query Parameters
format
any
Enum: "SVG" "PNG"

Формат изображения

withLogo
boolean
Default: true

Отображение логотипа СБП в QR-коде

Responses

Получение данных заказа с сплитованием

Authorizations:
BearerAuth
path Parameters
id
required
string

Идентификатор заказа

Responses

Response samples

Content type
application/json
Example

Ответ на создание заказа без указаниям ограничений Отсутствует блок restrictions

{
  • "id": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "amount": 8573.79,
  • "totalTaxAmount": 2.41,
  • "creationDate": "2024-06-12T19:35:55+03:00",
  • "expirationDate": "2024-08-12T20:35:55+03:00",
  • "status": "ACTIVE",
  • "receiverPaymentPurpose": "Какое-то назначение платежа",
  • "senderPaymentPurpose": "Какое-то назначение платежа",
  • "redirectUrl": "https://exampletsp.io/qwertyui",
  • "splits": [
    ],
  • "extra": {
    },
  • "qr": {}
}

Отмена заказа с сплитованием

Метод позволяет отменить неоплаченный заказ с сплитованием. После отмены оплата заказа с текущим id будет недоступна. Но вы можете переиспользовать этот id для создания нового заказа

Authorizations:
BearerAuth
path Parameters
id
required
string

Идентификатор заказа

Responses

Response samples

Content type
application/json
{
  • "code": "FORBIDDEN",
  • "message": "Доступ запрещен"
}

Заявки

Создание заявки

Authorizations:
BearerAuth
header Parameters
Content-Digest
required
string
Example: yxlZv97...

Дайджест, подписываемый клиентом, является строкой в формате base64, в которой хранится результат хеш-функции sha256, представленный массивом байт. Подробности создания можно найти в инструкции.

Signature
required
string
Example: MIAGCSqGSIb3D...

Подпись в формате base64, созданная при использовании RBO-сертификата. Подробности создания можно найти в инструкции.

Request Body schema: application/json
required
type
required
string

Тип заявки

purpose
required
string
Value: "COUNTERPARTY"

Назначение счета

account
required
string = 20 characters

Банковский счёт ЮЛ или ИП

corrAccount
required
string = 20 characters

Номер корреспондентского счета банка

bic
required
string = 9 characters

БИК банка

legalName
required
string

Наименование юридического лица

inn
required
string [ 10 .. 12 ] characters

ИНН юридического лица

kpp
string = 9 characters

КПП юридического лица

Responses

Request samples

Content type
application/json
{
  • "type": "REQUISITES",
  • "purpose": "COUNTERPARTY",
  • "account": "40817810601002630020",
  • "corrAccount": "30101810200000000700",
  • "bic": "123456789",
  • "legalName": "ООО \"Ромашка\"",
  • "inn": "1234567890",
  • "kpp": "123456789"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "ON_SIGNING",
  • "request": {
    },
  • "createdDate": "2024-06-12T19:35:55+03:00"
}

Список заявок

Authorizations:
BearerAuth
query Parameters
limit
integer

Количество операций в ответе

offset
integer

Смещение списка операций

createdDateFrom
string <date-time>
Example: createdDateFrom=2024-06-12T19:36:55+03:00

Дата создания от

createdDateTo
string <date-time>
Example: createdDateTo=2024-06-13T19:36:55+03:00

Дата создания до

type
string (ApplicationType)
Value: "REQUISITES"
Example: type=REQUISITES

Тип заявки

status
string (ApplicationStatus)
Enum: "ON_SIGNING" "PARTLY_SIGNED" "IN_PROGRESS" "CANCELLED" "SUCCESS" "ERROR"
Example: status=ON_SIGNING

Статус заявки

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "data": [
    ]
}

Получение данных заявки

Authorizations:
BearerAuth
path Parameters
id
required
string

Идентификатор заявки

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "ON_SIGNING",
  • "request": {
    },
  • "createdDate": "2024-06-12T19:35:55+03:00"
}

Счета

Получение списка счетов

Получение списка счетов

Authorizations:
BearerAuth
query Parameters
purpose
string
Value: "COUNTERPARTY"

Назначение счета

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Получение информации о счете

Получение информации о счете

Authorizations:
BearerAuth
path Parameters
id
required
string <UUID>
Example: 1b60b182-b20d-4271-aaeb-a554a0712cd0

Идентификатор счета

Responses

Response samples

Content type
application/json
{
  • "id": "1b60b182-b20d-4271-aaeb-a554a0712cd0",
  • "purpose": "COUNTERPARTY",
  • "account": "12345678901234567890",
  • "corrAccount": "12345678901234567890",
  • "bic": "123456789",
  • "legalName": "ООО \"Ромашка\"",
  • "inn": "1234567890",
  • "kpp": "123456789"
}

Уведомления об операциях

Для информирования клиента о проведённых платежах могут использоваться HTTP-уведомления на адрес, указанный в его настройках.

Боевой адрес можно указать в личном кабинете во вкладке "Прием платежей"

Также адрес для тестовой и боевой среды можно указать с помощью метода в API.

Для партнёра уведомление представляет собой входящий POST-запрос, который использует JSON-структуру.

Уведомление считается принятым, если получатель ответил на запрос кодом HTTP 200.

Ответы с любыми другими HTTP-кодами будут считаться невалидными. Повторные попытки отправки будут проводиться с интервалами: 5 сек, 1 мин, 12 мин и 2 ч 24 мин

Для проверки подлинности уведомления по Заказу и Многоразовой платежной ссылке к данным добавляется подпись в заголовке X-Api-Signature-SHA256 , полученная на основе общего секретного ключа и контрольной строки id|qr.id|payment.id|payment.status.value|payment.amount|payment.status.date с помощью HMAC-SHA-256.

Необходимо проверять сумму для проверки корректности уведомления.

Уведомления отправляются с IP 193.28.44.23

Уведомление о входящем платеже Webhook

Request Body schema: application/json
event
string
Value: "B2B_PAYMENT"

Тип операции

object

Responses

Request samples

Content type
application/json
{
  • "event": "B2B_PAYMENT",
  • "data": {
    }
}

Настройка url для callback

Для подписи уведомлений будет использоваться ключ из заголовка авторизации.

Authorizations:
BearerAuth
Request Body schema: application/json
callbackUrl
required
string

URL для приёма уведомлений

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Реестр

Реестры по платежам отправляются на ежедневной, еженедельной, ежемесячной основе, в зависимости от выставленной настройки. В РБО -> Прием платежей -> Реестры

Инструкция по настройке реестров

В случае отсутствия операций за день, реестр на следующий день не отправляется.

Формат реестра:

Наименование колонки Значение
Мерчант Идентификатор в системе СБП
Дата операции МСК Дата и время проведения операции (МСК)
ID платежной ссылки Уникальный идентификатор платежной ссылки (qrId)
ID операции Внутренний идентификатор платежа
ID операции НСПК Идентификатор операции в системе НСПК
ID заказа Уникальный идентификатор заказа в системе партнёра
Основание операции в выписке Назначение платежа в выписке получателя
Назначение платежа Расширенное Назначение Платежа
Сумма Сумма Операции
НДС Сумма НДС
Дополнительные поля Дополнительные поля, указанные получателем (extra)
Комиссия Комиссия за транзакцию
Наименования плательщика Наименование Юридического Лица Плательщика
Банковский счёт плательщика Номер банковского счета Плательщика
ИНН плательщика Идентификационный номер налогоплательщика Плательщика
ID банка плательщика Идентификатор Банка Плательщика
Наименование банка плательщика Наименование Банка Плательщика
Бик банка плательщика Банковский Идентификационный Код Банка Плательщика

Пример реестра в кодировке WIN-1251 для Windows систем

Пример реестра в кодировке UTF-8 для UNIX систем