Raiff logo
Documentation Powered by ReDoc

Raiffeisenbank cards API

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

Authentication

Authorization

Security Scheme Type HTTP
HTTP Authorization Scheme Bearer

Получатель

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

Responses

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

Уникальный идентификатор QR

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип QR-кода

account
required
string\d{20}

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

merchantId
required
string 12 characters

Идентификатор зарегистрированного партнёра в СБП

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12 characters

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

paymentPurpose
string <= 210 characters

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

amount
integer <int64> <= 12 characters

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

expirationDate
integer <int32>

Срок жизни QR кода в минутах.

redirectUrl
string <= 1024 characters

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

orderId
required
string [ 1 .. 40 ] characters

Уникальный идентификатор заказа QR, назначаемый Получателем

uip
string [ 1 .. 35 ] characters

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

payload
required
string <= 999 characters

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

qrStatus
required
string
Value: "CREATED"

Статус QR-кода

image
string

URL с изображением зарегистрированного QR-кода

Response samples

Content type
application/json
[
  • {
    • "qrId": "string",
    • "qrType": "DYNAMIC",
    • "account": "string",
    • "merchantId": "stringstring",
    • "takeTax": true,
    • "totalTaxAmount": 0,
    • "paymentPurpose": "string",
    • "amount": 0,
    • "expirationDate": 0,
    • "redirectUrl": "string",
    • "orderId": "string",
    • "uip": "string",
    • "payload": "string",
    • "qrStatus": "CREATED",
    • "image": "string"
    }
]

Регистрация нового QR

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

Тип QR-кода

account
required
string\d{20}

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

merchantId
required
string <= 12 characters

Идентификатор зарегистрированного партнёра в СБП

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

Сумма НДС в рублях. Поле обязательное при qrType = "DYNAMIC" И takeTax = "true"

paymentPurpose
string <= 210 characters

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

amount
integer <int64> <= 12

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

expirationDate
integer <int32>

Срок жизни QR кода в минутах. Поле не заполняется при qrType = "STATIC"

redirectUrl
string <= 1024 characters

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

orderId
required
string [ 1 .. 40 ] characters

Уникальный идентификатор заказа QR, назначаемый Получателем

uip
string [ 1 .. 35 ] characters

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

Responses

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

Уникальный идентификатор QR

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип QR-кода

account
required
string\d{20}

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

merchantId
required
string 12 characters

Идентификатор зарегистрированного партнёра в СБП

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12 characters

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

paymentPurpose
string <= 210 characters

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

amount
integer <int64> <= 12 characters

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

expirationDate
integer <int32>

Срок жизни QR кода в минутах.

redirectUrl
string <= 1024 characters

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

orderId
required
string [ 1 .. 40 ] characters

Уникальный идентификатор заказа QR, назначаемый Получателем

uip
string [ 1 .. 35 ] characters

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

payload
required
string <= 999 characters

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

qrStatus
required
string
Value: "CREATED"

Статус QR-кода

image
string

URL с изображением зарегистрированного QR-кода

Request samples

Content type
application/json
{
  • "qrType": "DYNAMIC",
  • "account": "string",
  • "merchantId": "string",
  • "takeTax": true,
  • "totalTaxAmount": 12,
  • "paymentPurpose": "string",
  • "amount": 12,
  • "expirationDate": 0,
  • "redirectUrl": "string",
  • "orderId": "string",
  • "uip": "string"
}

Response samples

Content type
application/json
{
  • "qrId": "string",
  • "qrType": "DYNAMIC",
  • "account": "string",
  • "merchantId": "stringstring",
  • "takeTax": true,
  • "totalTaxAmount": 0,
  • "paymentPurpose": "string",
  • "amount": 0,
  • "expirationDate": 0,
  • "redirectUrl": "string",
  • "orderId": "string",
  • "uip": "string",
  • "payload": "string",
  • "qrStatus": "CREATED",
  • "image": "string"
}

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

path Parameters
qrId
required
string

Уникальный идентификатор QR

Responses

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

Уникальный идентификатор QR

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип QR-кода

account
required
string\d{20}

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

merchantId
required
string 12 characters

Идентификатор зарегистрированного партнёра в СБП

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12 characters

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

paymentPurpose
string <= 210 characters

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

amount
integer <int64> <= 12 characters

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

expirationDate
integer <int32>

Срок жизни QR кода в минутах.

redirectUrl
string <= 1024 characters

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

orderId
required
string [ 1 .. 40 ] characters

Уникальный идентификатор заказа QR, назначаемый Получателем

uip
string [ 1 .. 35 ] characters

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

payload
required
string <= 999 characters

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

qrStatus
required
string
Value: "CREATED"

Статус QR-кода

image
string

URL с изображением зарегистрированного QR-кода

Response samples

Content type
application/json
{
  • "qrId": "string",
  • "qrType": "DYNAMIC",
  • "account": "string",
  • "merchantId": "stringstring",
  • "takeTax": true,
  • "totalTaxAmount": 0,
  • "paymentPurpose": "string",
  • "amount": 0,
  • "expirationDate": 0,
  • "redirectUrl": "string",
  • "orderId": "string",
  • "uip": "string",
  • "payload": "string",
  • "qrStatus": "CREATED",
  • "image": "string"
}

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

path Parameters
qrId
required
string

Уникальный идентификатор QR

Responses

Response Schema: application/json
Array
transactionDate
required
string <date-time>

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

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

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

transactionId
required
integer <int64>

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

amount
required
integer <int64> <= 12

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

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

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

paymentPurpose
string <= 210 characters

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

orderId
string [ 1 .. 40 ] characters

Уникальный идентификатор платежа, назначаемый Получателем

uip
string [ 1 .. 35 ] characters

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

required
object (SenderDto)

Response samples

Content type
application/json
[
  • {
    • "transactionDate": "2019-08-24T14:15:22Z",
    • "paymentStatus": "SUCCESS",
    • "transactionId": 0,
    • "amount": 12,
    • "takeTax": true,
    • "totalTaxAmount": 12,
    • "paymentPurpose": "string",
    • "orderId": "string",
    • "uip": "string",
    • "sender": {
      • "legalName": "string",
      • "inn": "stringstri",
      • "brandName": "string",
      • "address": "string",
      • "mcc": "stri"
      }
    }
]

Отправитель

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

path Parameters
qrId
required
string <= 32 characters

Уникальный идентификатор QR в СБП

Request Body schema: application/json
amount
required
integer <int64>

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

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

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

paymentPurpose
string <= 210 characters

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

Responses

Response Schema: */*
qrId
required
string <= 32 characters

Уникальный идентификатор QR в СБП

paymentId
required
string

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

amount
required
integer <int64> <= 12

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

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

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

paymentPurpose
string <= 210 characters

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

Request samples

Content type
application/json
{
  • "amount": 0,
  • "takeTax": true,
  • "totalTaxAmount": 12,
  • "paymentPurpose": "string"
}

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

path Parameters
qrId
required
string <= 32 characters

Уникальный идентификатор QR в СБП

Responses

Response Schema: */*
qrId
required
string <= 32 characters

Уникальный идентификатор QR

qrType
required
string
Enum: "DYNAMIC" "STATIC"

Тип QR-кода

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

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

amount
integer <int64> <= 12

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

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

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

mcc
required
string 4 characters

MCC-код получателя

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

path Parameters
qrId
required
string <= 32 characters

Уникальный идентификатор QR в СБП

paymentId
required
string

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

Responses

Response Schema: */*
qrId
required
string <= 32 characters

Уникальный идентификатор QR в СБП

paymentId
required
string

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

transactionDate
required
string <date-time>

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

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

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

amount
required
integer <int64> <= 12

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

takeTax
required
boolean

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

totalTaxAmount
integer <int64> <= 12

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

paymentPurpose
string <= 210 characters

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