Raiff logo
Documentation Powered by ReDoc

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

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

Authentication

Authorization

Security Scheme Type HTTP
HTTP Authorization Scheme Bearer

Получатель

Регистрация платёжной ссылки

Request Body schema: application/json
qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип платёжной ссылки. Возможные значения:
• DYNAMIC – для динамической (разовой) платёжной ссылки
• STATIC – для статической (многоразовой) платёжной ссылки

qrName
string <= 255 characters

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

account
required
string 20 characters

Банковский счёт ЮЛ или ИП для зачисления средств

takeTax
required
boolean

Информация о взимании НДС. Допустимые значения:
• true – облагается НДС
• false – не облагается НДС

totalTaxAmount
number <float> <= 1000000

Сумма НДС в рублях. Поле не заполняется при takeTax = "false". Поле обязательное при qrType = "DYNAMIC" И takeTax = "true". Не должна превышать значение суммы операции (amount)

amount
number <float> <= 1000000

Сумма операции в рублях. Поле обязательное при qrType = "DYNAMIC" ИЛИ qrType = "STATIC" И takeTax = "true" И totalTaxAmount не пустое значение. Максимальное значение - 1000000 рублей

paymentPurpose
string <= 210 characters

Назначение платежа. Поле обязательное при qrType = "DYNAMIC"

expirationDate
string <date-time>

Срок жизни платёжной ссылки. Поле не заполняется при qrType = "STATIC". Минимальный срок жизни - 1 минута. Максимальный срок жизни - 90 дней. Значение по умолчанию - 3 суток.

redirectUrl
string <= 1024 characters

Cсылка для автоматического возврата плательщика из приложения банка в приложение или на сайт ТСП. Допускаются только символы в кодировке ASCII. Формат должен соответствовать спецификации RFC-3986

uip
string <= 35 characters

УИП (уникальный идентификатор платежа). Поле не заполняется при qrType = "STATIC"

extra
object

Дополнительные поля. Строка в формате json

Responses

Response Schema: application/json
qrId
required
string <= 32 characters

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

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип платёжной ссылки

qrName
string <= 255 characters

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

account
required
string 20 characters

Банковский счёт ЮЛ или ИП для зачисления средств

takeTax
required
boolean

Информация о взимании НДС

totalTaxAmount
number <float> <= 1000000

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

amount
number <float> <= 1000000

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

paymentPurpose
string <= 210 characters

Назначение платежа

creationDate
required
string <date-time>

Дата создания платёжной ссылки

expirationDate
string <date-time>

Срок жизни платёжной ссылки

redirectUrl
string <= 1024 characters

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

uip
string <= 35 characters

УИП (уникальный идентификатор платежа)

payload
required
string <= 999 characters

Функциональная ссылка

qrStatus
required
string
Enum: "CREATED" "EXPIRED" "PAID"

Статус платёжной ссылки:
• CREATED – создана
• EXPIRED - срок действия истёк
• PAID - оплачен

object (ImageDto)
extra
object

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

bankName
required
string

Наименование банка Получателя

Request samples

Content type
application/json
{
  • "qrType": "DYNAMIC",
  • "qrName": "Оплата услуги",
  • "account": 40817810601002630000,
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "Какое-то назначение платежа",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "redirectUrl": "https://exampletsp.io/qwertyui",
  • "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "extra": {
    • "additionalInfo": "testing operation"
    }
}

Response samples

Content type
application/json
{
  • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "qrType": "DYNAMIC",
  • "qrName": "Оплата услуги",
  • "account": 40817810601002630000,
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "Какое-то назначение платежа",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "redirectUrl": "https://exampletsp.io/qwertyui",
  • "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "payload": "https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "qrStatus": "CREATED",
  • "image": {
    • "mediaType": "image/png",
    • "content": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII="
    },
  • "extra": {
    • "additionalInfo": "testing operation"
    },
  • "bankName": "Райффайзен Банк"
}

Получение списка зарегистрированных платёжных ссылок

query Parameters
page
integer <int32>
Default: 1

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

size
integer <int32>
Default: 20

Количество отображаемых платёжных ссылок

fromDate
string <date>

Дата начала периода фильтрации по дате создания платёжной ссылки

toDate
string <date>

Дата окончания периода фильтрации по дате создания платёжной ссылки

qrStatus
string
Enum: "CREATED" "EXPIRED" "PAID"

Статус платёжной ссылки

qrType
string
Enum: "DYNAMIC" "STATIC"

Тип платёжной ссылки

search
string

Поле для поиска по наименованию платёжной ссылке или по сумме операции

Responses

Response Schema: application/json
Array of objects (QrResponseDto) [ items ]
object (Meta)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
      • "qrType": "DYNAMIC",
      • "qrName": "Оплата услуги",
      • "account": 40817810601002630000,
      • "takeTax": true,
      • "totalTaxAmount": 2.41,
      • "amount": 8573.79,
      • "paymentPurpose": "Какое-то назначение платежа",
      • "creationDate": "2019-08-24T14:15:22Z",
      • "expirationDate": "2019-08-24T14:15:22Z",
      • "redirectUrl": "https://exampletsp.io/qwertyui",
      • "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
      • "payload": "https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
      • "qrStatus": "CREATED",
      • "image": {
        • "mediaType": "image/png",
        • "content": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII="
        },
      • "extra": {
        • "additionalInfo": "testing operation"
        },
      • "bankName": "Райффайзен Банк"
      }
    ],
  • "meta": {
    • "page": "1",
    • "size": "20",
    • "hasNext": true,
    • "count": "14"
    }
}

Получение данных по зарегистрированной платёжной ссылке

path Parameters
qrId
required
string

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

Responses

Response Schema: application/json
qrId
required
string <= 32 characters

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

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип платёжной ссылки

qrName
string <= 255 characters

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

account
required
string 20 characters

Банковский счёт ЮЛ или ИП для зачисления средств

takeTax
required
boolean

Информация о взимании НДС

totalTaxAmount
number <float> <= 1000000

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

amount
number <float> <= 1000000

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

paymentPurpose
string <= 210 characters

Назначение платежа

creationDate
required
string <date-time>

Дата создания платёжной ссылки

expirationDate
string <date-time>

Срок жизни платёжной ссылки

redirectUrl
string <= 1024 characters

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

uip
string <= 35 characters

УИП (уникальный идентификатор платежа)

payload
required
string <= 999 characters

Функциональная ссылка

qrStatus
required
string
Enum: "CREATED" "EXPIRED" "PAID"

Статус платёжной ссылки:
• CREATED – создана
• EXPIRED - срок действия истёк
• PAID - оплачен

object (ImageDto)
extra
object

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

bankName
required
string

Наименование банка Получателя

Response samples

Content type
application/json
{
  • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "qrType": "DYNAMIC",
  • "qrName": "Оплата услуги",
  • "account": 40817810601002630000,
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "Какое-то назначение платежа",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "redirectUrl": "https://exampletsp.io/qwertyui",
  • "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
  • "payload": "https://b2b.cbrpay.ru/AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "qrStatus": "CREATED",
  • "image": {
    • "mediaType": "image/png",
    • "content": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII="
    },
  • "extra": {
    • "additionalInfo": "testing operation"
    },
  • "bankName": "Райффайзен Банк"
}

Получение списка платежей по платёжной ссылке

path Parameters
qrId
required
string

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

query Parameters
page
integer <int32>
Default: 1

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

size
integer <int32>
Default: 20

Количество отображаемых платёжных ссылок

fromDate
string <date>

Дата начала периода фильтрации по дате проведения платежа

toDate
string <date>

Дата окончания периода фильтрации по дате проведения платежа

fromAmount
number <float>

Начальная сумма для фильтрации по сумме платежа

toAmount
number <float>

Конечная сумма для фильтрации по сумме платежа

search
string

Поле для поиска по наименованию ЮЛ или ИП Плательщика или по ИНН ЮЛ или ИП Плательщика

Responses

Response Schema: application/json
Array of objects (PaymentResponseDto) [ items ]
object (Meta)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "qrId": "string",
      • "sbpTransactionId": "stringstringstringstringstringst",
      • "transactionDate": "2019-08-24T14:15:22Z",
      • "creationDate": "2019-08-24T14:15:22Z",
      • "paymentStatus": "SUCCESS",
      • "amount": 1000000,
      • "takeTax": true,
      • "totalTaxAmount": 1000000,
      • "paymentPurpose": "string",
      • "uip": "string",
      • "receiver": {
        • "account": "string",
        • "legalName": "string",
        • "inn": "stringstri",
        • "brandName": "string"
        },
      • "sender": {
        • "legalName": "string",
        • "bankName": "string",
        • "inn": "stringstri"
        }
      }
    ],
  • "meta": {
    • "page": "1",
    • "size": "20",
    • "hasNext": true,
    • "count": "14"
    }
}

Плательщик

Получение данных платёжной ссылки

path Parameters
qrId
required
string <= 32 characters

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

Responses

Response Schema: application/json
qrId
required
string <= 32 characters

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

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип платёжной ссылки

takeTax
required
boolean

Информация о взимании НДС

totalTaxAmount
number <float> <= 1000000

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

amount
number <float> <= 1000000

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

paymentPurpose
string <= 210 characters

Назначение платежа

legalName
required
string <= 512 characters

Сокращенное наименование ЮЛ или ИП получателя

inn
required
string [ 10 .. 12 ] characters

ИНН ЮЛ или ИП получателя

brandName
required
string <= 35 characters

Торговое наименование ТСП получателя

address
required
string <= 140 characters

Фактический адрес ТСП получателя

required
object (MccCodeDto)
bankName
required
string

Наименование банка Получателя

redirectUrl
string <= 1024 characters

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

Response samples

Content type
application/json
{
  • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "qrType": "DYNAMIC",
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "Какое-то назначение платежа",
  • "legalName": "ООО Торг",
  • "inn": 4285733785,
  • "brandName": "ООО Торг на Б.Татарской",
  • "address": "г. Москва, ул. Б.Татарская, д.133, стр.1",
  • "mcc": {
    • "code": 4121,
    • "title": "Лимузины и такси"
    },
  • "bankName": "Райффайзен Банк",
  • "redirectUrl": "https://exampletsp.io/qwertyui"
}

Создание платежа

path Parameters
qrId
required
string <= 32 characters

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

Request Body schema: application/json
account
required
string 20 characters

Банковский счёт ЮЛ или ИП для списания средств

takeTax
required
boolean

Информация о взимании НДС. Допустимые значения:
• true – облагается НДС
• false – не облагается НДС

totalTaxAmount
number <float> <= 1000000

Сумма НДС в рублях. Поле не заполняется при takeTax = "false". Если значение указано в реквизитах платежной ссылки, то заполняется значением полученным при получении данных платежной ссылки. Иначе, заполняется плательщиком самостоятельно. Не должна превышать значение суммы операции (amount)

amount
required
number <float> <= 1000000

Сумма операции в рублях. Если значение указано в реквизитах платежной ссылки, то заполняется значением полученным при получении данных платежной ссылки. Иначе, заполняется плательщиком самостоятельно. Максимальное значение - 1000000 рублей

paymentPurpose
required
string <= 210 characters

Назначение платежа. Если значение указано в реквизитах платежной ссылки, то заполняется значением полученным при получении данных платежной ссылки. Иначе, заполняется плательщиком самостоятельно.

extra
object

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

Responses

Response Schema: application/json
qrId
required
string <= 32 characters

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

transactionId
required
string

Идентификатор операции в Райффайзенбанке

createdDate
required
string <date-time>

Дата и время создания платежа

account
required
string 20 characters

Банковский счёт ЮЛ или ИП для списания средств

takeTax
required
boolean

Информация о взимании НДС. Допустимые значения:
• true – облагается НДС
• false – не облагается НДС

totalTaxAmount
number <float> <= 1000000

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

amount
required
number <float> <= 1000000

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

paymentPurpose
required
string <= 210 characters

Назначение платежа

extra
object

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

Request samples

Content type
application/json
{
  • "account": 40817810601002630000,
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "Какое-то назначение платежа",
  • "extra": {
    • "additionalInfo": "testing operation"
    }
}

Response samples

Content type
application/json
{
  • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "transactionId": 10092,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "account": 40817810601002630000,
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "paymentPurpose": "string",
  • "extra": {
    • "additionalInfo": "testing operation"
    }
}

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

path Parameters
qrId
required
string <= 32 characters

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

transactionId
required
string

Идентификатор операции в Райффайзенбанке

Responses

Response Schema: application/json
qrId
required
string <= 32 characters

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

transactionId
required
string

Идентификатор операции в Райффайзенбанке

sbpTransactionId
string 32 characters

Уникальный идентификатор операции на уровне всей системы СБП

account
required
string 20 characters

Счёт списания

transactionDate
required
string <date-time>

Дата и время проведения платежа

createdDate
required
string <date-time>

Дата и время создания платежа

paymentStatus
required
string
Enum: "SUCCESS" "DECLINED" "IN_PROGRESS"

Статус платежа

paymentPurpose
required
string <= 210 characters

Назначение платежа

takeTax
required
boolean

Информация о взимании НДС

totalTaxAmount
number <float> <= 1000000

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

amount
required
number <float> <= 1000000

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

extra
object

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

object (ReceiverDto)

Response samples

Content type
application/json
{
  • "qrId": "AS1B001K33DNHAKV2KNBJRQK6KHNQKJ5",
  • "transactionId": 10092,
  • "sbpTransactionId": "B1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K3",
  • "account": 40817810601002630000,
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "SUCCESS",
  • "paymentPurpose": "Какое-то назначение платежа",
  • "takeTax": true,
  • "totalTaxAmount": 2.41,
  • "amount": 8573.79,
  • "extra": {
    • "additionalInfo": "testing operation"
    },
  • "receiver": {
    • "legalName": "ООО Торг",
    • "inn": 4285733785,
    • "brandName": "ООО Торг на Б.Татарской",
    • "address": "г. Москва, ул. Б.Татарская, д.133, стр.1",
    • "mcc": {
      • "code": 4121,
      • "title": "Лимузины и такси"
      }
    }
}

Справочные данные

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

Responses

Response Schema: application/json
Array
account
string 20 characters

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

availableBalance
number <float>

Значение доступного баланса

Response samples

Content type
application/json
[
  • {
    • "account": "40817810601002630020",
    • "availableBalance": 8573.79
    }
]

Получение списка банков участнков программы СБП

Responses

Response Schema: application/json
Array
memberId
required
string

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

memberNameRus
required
string

Наименование банка

bic
string

bic-код банка

role
string
Enum: "RECEIVER" "SENDER" "BOTH"

Тип участия в СБП. Возможные значения:
• RECEIVER – только получает платежи
• SENDER – только отправляет платежи
• BOTH – получает и отправляет платежи

Response samples

Content type
application/json
[
  • {
    • "memberId": "100000000007",
    • "memberNameRus": "Райффайзенбанк",
    • "bic": "044525700",
    • "role": "RECEIVER"
    }
]