Callback Notifications API (1.0)

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

Общая информация

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

Формат уведомлений

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

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

Ответы с любыми другими HTTP-кодами будут считаться невалидными. Повторные попытки отправки проводятся в течение суток с нарастающим интервалом.

Проверка подлинности

Для проверки подлинности уведомлений к данным добавляется подпись в заголовке X-Api-Signature-SHA256, полученная на основе общего секретного ключа и контрольной строки с помощью HMAC-SHA-256.

Тип операции Тип уведомления Шаблон проверки Актуальность
Оплата
Уведомление об оплате (v3) data.amount|data.publicId|data.order.id|data.status.value|data.status.date
Уведомление об оплате (v2) amount|publicId|order|transaction.status.value|transaction.status.date ⚠️
Уведомление об оплате (v1) amount|sbpMerchantId|order|paymentStatus|transactionDate ⚠️
Возвраты
Уведомление о возврате (v1) amount|publicId|refund.id|status.value|status.date
Подписки
Уведомление о подписке (v2) data.publicId|data.id|data.status.value|data.status.date
Уведомление о подписке (v1) data.publicId|data.id|data.status.value|data.status.date ⚠️

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

Настройка уведомлений

Боевой адрес можно указать:

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

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

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

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

object

Настройки типов операций

Responses

Request samples

Content type
application/json
{
  • "callbackUrl": "https://yoururl.ru",
  • "operationTypes": {
    }
}

Response samples

Content type
application/json
{
  • "callbackUrl": "https://yoururl.ru",
  • "operationTypes": {
    }
}

Платеж

Уведомление об оплате (v3) Webhook

Уведомление о платеже для эквайринга и СБП.

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

Request Body schema: application/json
event
required
string
Value: "PAYMENT"

Тип сообщения

required
any

Данные по операции

Request samples

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

Уведомление об оплате (v2) Deprecated Webhook

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

Request Body schema: application/json
event
required
string
Value: "payment"

Тип сообщения

required
any (PaymentTransactionV2)

Данные по операции

Request samples

Content type
application/json
Example
{
  • "event": "payment",
  • "transaction": {
    }
}

Уведомление об оплате (v1) Deprecated Webhook

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

Request Body schema: application/json
transactionId
number

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

qrId
string <= 32 characters

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

sbpMerchantId
string <= 12 characters

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

merchantId
string

Идентификатор ТСП в Райффайзенбанке

amount
number

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

currency
string <= 3 characters

Валюта платежа

transactionDate
string <date-time>

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

paymentStatus
string

Статус проведения платежа

additionalInfo
string <= 140 characters

Дополнительная информация

order
string <= 40 characters ^[A-Za-z0-9-_.]+$

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

createDate
string <date-time>

Время формирования заявки

object

Дополнительные поля, переданные в запросе ранее

Request samples

Content type
application/json
{
  • "transactionId": 41,
  • "qrId": "AS100032PQ7739G58NCQ457RA2OG82JP",
  • "sbpMerchantId": "MA0000000279",
  • "merchantId": "1780672001",
  • "amount": 10,
  • "currency": "RUB",
  • "transactionDate": "2020-01-15T16:01:49.043924+03:00",
  • "paymentStatus": "SUCCESS",
  • "additionalInfo": "Дополнительная информация",
  • "order": "testOrder",
  • "createDate": "2020-01-15T13:00:40+03:00",
  • "extra": {
    }
}

Возврат

Уведомление о возврате (v1) Webhook

Уведомление о возврате для эквайринга и СБП.

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

Request Body schema: application/json
One of
object

Request samples

Content type
application/json
Example
{
  • "refund": {
    }
}

Подписка

Уведомление о подписке (v2) Webhook

Уведомление об изменении подписки.

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

Request Body schema: application/json
event
required
string
Value: "SUBSCRIPTION"

Тип сообщения

required
any

Данные о подписке

Request samples

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

Уведомление о подписке (v1) Deprecated Webhook

header Parameters
X-Api-Signature-SHA256
required
string

Заполняется подписью, полученной алгоритмом HMAC-SHA-256 с использованием выбранного секретного ключа и контрольной строки

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

Тип сообщения

object

Request samples

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