СБП

Введение

Вы можете принимать платежи через СБП (Систему Быстрых Платежей) Национальной Системы Платежных Карт (НСПК). В этом случае вместо ввода карточных данных на платежной странице в браузере клиент сканирует динамический QR-код и производит оплату. Если используется мобильное приложение, клиент нажимает на кнопку оплаты СБП и переходит по ссылке, выбирая приложение банка для оплаты.

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

Схемы интеграции

Оплата на платёжной странице

1. Клиент оформляет заказ и переходит к оплате.
2. Мерчант отправляет в Платежный шлюз запрос на регистрацию заказа register.do.
3. В ответе на запрос регистрации Платежный шлюз возвращает уникальный идентификатор заказа в платёжной системе (в параметре orderId) и URL, на который необходимо перенаправить Клиента для получения платёжной формы (в параметре formUrl).
4. Система Мерчанта передаёт браузеру Клиента redirect на URL (см. Шаг 3).
5. Браузер Клиента запрашивает платёжную форму по указанному URL.
6. Браузер отображает платёжную страницу, где Клиент выбирает оплату через СБП.
7. Платёжная страница запрашивает у Платежного шлюза QR-код.
8. Платежный шлюз отправляет в НСПК запрос QR-кода.
9. НСПК возвращает ответ на запрос QR-кода.
10. Клиенту на платёжной странице отображается QR-код или (в случае мобильного приложения) кнопка для оплаты.
11. Клиент считывает QR-код при помощи специализированного ПО или (в случае мобильного приложения) нажимает кнопку, после чего производит оплату.
12. Платежный шлюз получает ответ с результатом оплаты.

13. Если оплата прошла неуспешно, то уменьшается количество попыток оплаты и Платежный шлюз направляет callback о неуспешной оплате системе Мерчанта.

    Если оплата прошла успешно, Шаги 13–14 пропускаются и выполняется переход на Шаг 15.
    

14. Если у Мерчанта настроена отправка уведомлений (callbacks, email), то отправляется уведомление Клиенту о неуспешной оплате заказа. Процесс останавливается.

15. Платежный шлюз направляет в НСПК запрос о конечном статусе платежа.

16. НСПК возвращает callback со статусом платежа.

17. Платежный шлюз переводит заказ в состояние "Завершен".

18. Платежный шлюз направляет callback об успешной оплате системе Мерчанта.

19. Если у Мерчанта настроена отправка уведомлений (callbacks, email), то отправляется уведомление Клиенту об успешной оплате заказа.

Оплата с вводом данных на стороне Мерчанта

1. Клиент оформляет заказ и переходит к оплате.
2. Мерчант отправляет в Платежный шлюз запрос на регистрацию заказа register.do.
3. В ответе на запрос регистрации Платежный шлюз возвращает уникальный идентификатор заказа в платежной системе (в параметре orderId).
4. Мерчант перенаправляет Клиента на свою платёжную форму.
5. Клиент выбирает оплату через СБП.
6. Мерчант направляет в Платежный шлюз запрос на получение QR-кода sbp/c2b/qr/dynamic/get.do
7. Платежный шлюз отправляет в НСПК запрос QR-кода.
8. НСПК возвращает ответ на запрос QR-кода.
9. Платежный шлюз возвращает в систему Мерчанта ответ на запрос QR-кода.
10. Клиенту отображается QR-код или (в случае мобильного приложения) кнопка для оплаты.
11. Клиент считывает QR-код при помощи специализированного ПО или (в случае мобильного приложения) нажимает кнопку, после чего производит оплату.
12. Платёжный шлюз получает ответ c результатом оплаты.

13. Если оплата прошла не успешно, то уменьшается количество попыток оплаты и Платежный шлюз направляет callback о неуспешной оплате системе Мерчанта.

    Если оплата прошла успешно, Шаги 13–14 пропускаются и выполняется переход на Шаг 15.
    

14. Если у Мерчанта настроена отправка уведомлений (callbacks, email), то отправляется уведомление Клиенту о неуспешной оплате заказа.

15. Мерчант запрашивает у Платёжного шлюза статус платежа sbp/c2b/qr/dynamic/status.do.

16. Платежный шлюз возвращает callback со статусом платежа.

17. Если у Мерчанта настроена отправка уведомлений (callbacks, email), то отправляется уведомление Клиенту об успешной оплате заказа.

Отмена запроса на оплату

1. Клиент желает отменить заказ/оплату по уже созданному QR-коду.
2. Мерчант отправляет в Платежный шлюз запрос на отмену QR-кода sbp/c2b/qr/dynamic/reject.do, передавая mdOrder и qrId.
3. Платежный шлюз проверяет возможность отмены QR-кода.
4. Платежный шлюз запрашивает статус QR-кода.
   

5. НСПК присылает ответ: Статус QR = ACWP (см. Статусы заказа).

   Если в ответе пришел другой статус, переход на Шаг 8.

6. Платежный шлюз присваивает заказу статус = Завершен.

7. Платежный шлюз отправляет ответ с ошибкой отмены.

8. НСПК присылает ответ: Статус QR = RCVD (см. Статусы заказа).

   Если в ответе пришел другой статус, переход на Шаг 10.

9. Платежный шлюз отправляет ответ с ошибкой отмены.

10. НСПК присылает ответ: Статус QR = RJCT или NTST (см. Статусы заказа).

11. Платежный шлюз обновляет статус QR-кода: Статус QR=REJECTED_BY_USER.

12. Платежный шлюз отправляет ответ с успешной отменой.

13. НСПК присылает уведомление об успешной оплате

14. НСПК присылает ответ со статусом QR = ACWP (см. Статусы заказа).

15. Платежный шлюз запрашивает автовозврат.

16. НСПК уведомляет Платежный шлюз об успешном возврате.

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

Статусы заказа

Возврат денежных средств

1. Мерчант отправляет в Платежный шлюз запрос на возврат денежных средств refund.do.
2. Платежный шлюз отправляет в НСПК запрос возможности возврата оплаты.
3. НСПК отправляет ответ на запрос.
4. Платежный шлюз обновляет историю транзакции.
5. В случае успешного ответа на запрос возможности возврата Платежный шлюз отправляет в НСПК запрос возврата денежных средств.
6. НСПК отправляет ответ на запрос.
7. Платежный шлюз обновляет историю транзакции.
8. Платежный шлюз возвращает результат выполнения операции возврата.

Если на Шаге 2 или Шаге 5 будет получена ошибка, то после обновления истории транзакции Платежный шлюз отправляет в систему Мерчанта errorCode=7 - "Системная ошибка".

API методы

Получить QR-код для оплаты по СБП

Для получения динамического QR-кода для оплаты через СБП используется запрос sbp/c2b/qr/dynamic/get.do.

Параметры запроса

Параметры ответа

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/sbp/c2b/qr/dynamic/get.do \
  --header 'Content-Type: application/json' \
  --data '{
    "userName": "test_user",
    "password": "test_user_password",
    "mdOrder": "04888d6f-7920-7531-8332-8de901efddd0",
    "qrFormat": "image"
}'

Пример успешного запроса

{
"qrId": "54d14bae6f7f4a73929308e9afa5915d",
"payload": "https://qr.nspk.ru/54d14bae6f7f4a73929308e9afa5915d",
"qrStatus": "STARTED"
}

Получение статуса СБП-платежа

Для получения статуса СБП-платежа с помощью динамического QR-кода используется запрос sbp/c2b/qr/status.do.

Параметры запроса

Параметры ответа

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/sbp/c2b/qr/status.do \
  --header 'Content-Type: application/json' \
  --data '{
    "userName": "test_user",
    "password": "test_user_password",
    "mdOrder": "04888d6f-7920-7531-8332-8de901efddd0",
    "qrId": "3946c0c02d1042f7b7e63cc0f1b52a95"
}'

Пример успешного запроса

{
"qrType": "DYNAMIC",
"qrStatus": "ACCEPTED",
"transactionState": "DEPOSITED"
}

Отклонение СБП-платежа

Для отклонения платежа СБП с помощью динамического QR-кода, используется запрос sbp/c2b/qr/dynamic/reject.do.

Параметры запроса

Параметры ответа

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/sbp/c2b/qr/dynamic/reject.do \
  --header 'Content-Type: application/json' \
  --data '{
    "userName": "test_user",
    "password": "test_user_password",
    "mdOrder": "04888d6f-7920-7531-8332-8de901efddd0",
    "qrId": "3946c0c02d1042f7b7e63cc0f1b52a95"
}'

Пример успешного запроса

{
"rejected": true
}

Создание статического QR-кода для оплаты SBP

Для создания статического QR-кода для оплаты СБП используется запрос templates/createTemplate.do.

Параметры запроса

Ниже приведены параметры блока qrTemplate (данные о размере QR-кода).

Параметры ответа

Ниже приведены параметры блока qrTemplate (данные о размере QR-кода).

Коды ответа HTTP в случае ошибок:

• 1 - неверный запрос
• 2 - обязательный параметр отсутствует

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/templates/createTemplate.do \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "test_user",
    "password": "test_user_password",
    "type": "SBP_QR",
    "name": "Test template",
    "distributionChannel": "Test distribution channel",
    "currency": "RUB",
    "qrTemplate": {
        "qrHeight": 15,
        "qrWidth": 15
    }
}'

Пример успешного запроса

{
  "templateId": "BS1A002R685NUVE58NNA6O3DF8ELMGUE",
  "name": "Test template",
  "distributionChannel": "Test distribution channel",
  "startDate": "2022-01-02T11:32:00",
  "endDate": "2122-03-01T11:49:50",
  "type": "SBP_QR",
  "status": "ACTIVE",
  "qrTemplate": {
    "renderedQr":"iVBORw0...CYII=",
    "payload": "https://qr.nspk.ru/BS1A002R685NUVE58NNA6O3DF8ELMGUE"
  }
}

Получение данных шаблона

Для получения данных шаблона используется запрос templates/getTemplateDetails.do.

Параметры запроса

Параметры ответа

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/templates/getTemplateDetails.do \
  --header 'Content-Type: application/json' \
  --data '{
    "userName": "test_user",
    "password": "test_user_password",
    "templateId": "886d674089f64538a055ec9494759ed"
}'

Пример запроса

{
  "templateId": "886d674089f64538a055ec9494759ed",
  "name": "Test template",
  "distributionChannel": "test distribution channel",
  "startDate": "2022-01-02T11:32:00",
  "endDate": "2122-03-01T11:49:50",
  "type": "SBP_QR",
  "status": "ACTIVE",
  "qrTemplate": {
    "payload": "https://qr.nspk.ru/886d674089f64538a055ec9494759ed"
}

Изменение данных статического QR-кода

Для изменения шаблона используется запрос templates/updateTemplate.do.

Параметры запроса

Параметры ответа

Примеры

Пример запроса

curl --request POST \
  --url https://vtb.rbsuat.com/payment/rest/templates/updateTemplate.do \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "test_user",
    "password": "test_user_password",
    "name": "Test template",
    "templateId": "cfa97cdf2a964661b79d9ba54205e1eb",
    "status": "ACTIVE"
    }
}'

Пример успешного запроса

{
    "templateId": "cfa97cdf2a964661b79d9ba54205e1eb",
    "name": "Test local template_133_update",
    "amount": 60000,
    "currency": "RUB",
    "distributionChannel": "test distribution channel",
    "startDate": "2022-01-02T11:32:00",
    "endDate": "2022-03-12T15:18:00",
    "useDate": "2022-02-02T17:16:59",
    "type": "SBP_QR",
    "status": "ACTIVE",
    "qrTemplate": {
        "payload": "https://qr.nspk.ru/cfa97cdf2a964661b79d9ba54205e1eb"
    }
}