Mir Pay

Введение

Платежная система Мир предоставляет возможность принимать платежи из приложений мерчанта или мобильных версий сайтов с использованием сервиса Mir Pay.

Если у вас есть разрешение на создание связок, то во время оплаты через Mir Pay вы можете создавать связки (сохраненные данные карты) для дальнейших регулярных платежей (рекуррентных платежей или платежей в рассрочку).

В следующих разделах описывается интеграция метода оплаты Mir Pay In-Application.

Чтобы принимать платежи через Mir Pay, у вас должна быть включена эта функция.

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

Платежная страница на стороне Платежного шлюза

1. Клиент формирует заказ на сайте мерчанта.
2. Продавец направляет в платежный шлюз запрос регистрации заказа.
   a. При одностадийном платеже - register.do;
   b. При двухстадийном платеже - registerPreAuth.do
3. Платежный шлюз регистрирует заказ и отправляет мерчанту ответ, содержащий параметр formUrl (платежный URL-адрес, на который мерчант должен перенаправить клиента) и параметр  orderId  (уникальный номер заказа в системе платежного шлюза).
4. Интернет-магазин перенаправляет клиента на URL, полученный в параметре  formUrl.
5. Браузер клиента открывает полученный URL.
6. Платежная страница запрашивает список возможных способов оплаты у платежного шлюза.
7. Платежный шлюз формирует Universal link.
8. Платежный шлюз в ответе возвращает опцию мерчанта Mir Pay и Universal link.
9. Клиент получает платежную форму с отрисованной кнопкой оплаты MirPay.
10. Клиент выбирает способ оплаты Mir Pay на платежной странице.
11. Платежная страница запускает Universal link на устройстве клиента.
12. Mir Pay проверяет подпись продавца и его участие в программе.
13. Mir Pay отображает список карт клиенту.
14. Клиент выбирает карту для оплаты в приложении Mir Pay.
15. Mir Pay передает браузеру клиента redirect на URL платежной страницы.
16. Mir Pay формирует данные платежа и отправляет зашифрованные данные платежа в платежный шлюз.
17. Платежный шлюз расшифровывает данные платежа.
18. Платежный шлюз осуществляет оплату.
19. Браузер клиента обращается к платежной странице для получения результата оплаты.
20. Платежная страница запрашивает у платежного шлюза результат оплаты.
21. Платежный шлюз возвращает результат оплаты на платежную страницу.
22. Платежная страница отображает результат оплаты клиенту.

Платежная страница/приложение на стороне мерчанта

Необходимые условия

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

Вместе с конечным сертификатом вы должны получить от службы технической поддержки следующее:

1. Документ «Стандарт платежной системы «Мир». Описание реализации Mir Pay Android In-Application операций для ТСП».
2. Библиотека MirPaySDK.aar для встраивания в мобильное приложение продавца.
3. Описание API в виде yaml-файла;
4. URL-адрес файла конечного сертификата ТСП на общедоступном Web-ресурсе Агрегатора (https://<хост участника>/jwks/-jwks.json), если данное ТСП поддерживает технологию In-Application Web-based операций.

1. Клиент выбирает способ оплаты Mir Pay на платежной странице мерчанта.
2. Продавец запускает скрипт подготовки операции In-Application через MirPaySDK в приложении Mir Pay / Продавец запускает скрипт подготовки операции In-Application через Deeplink или Universal Link в приложении Mir Pay.
3. Mir Pay проверяет подпись продавца и его участие в программе.
4. Mir Pay отображает список карт клиенту.
5. Клиент выбирает карту для оплаты в приложении Mir Pay.
6. Mir Pay формирует данные платежа и отправляет зашифрованные данные платежа продавцу.
7. Продавец запрашивает платеж, отправляя API-запрос /mir/payment.do в платежный шлюз.
8. Платежный шлюз расшифровывает данные платежа.
9. Платежный шлюз осуществляет оплату.
10. Платежный шлюз возвращает результат оплаты мерчанту.
11. Мерчант отображает результат оплаты клиенту.

Расшифровка платежных данных на стороне продавца

1. Клиент выбирает способ оплаты Mir Pay на платежной странице.
2. Продавец запускает скрипт подготовки операции In-Application через MirPaySDK в приложении Mir Pay / Продавец запускает скрипт подготовки операции In-Application через Deeplink или Universal Link в приложении Mir Pay.
3. Mir Pay проверяет подпись продавца и его участие в программе.
4. Mir Pay отображает список карт клиенту.
5. Клиент выбирает карту для оплаты в приложении Mir Pay.
6. Mir Pay формирует данные платежа и отправляет зашифрованные данные платежа в мерчанту.
7. Продавец расшифровывает данные платежа.
8. Продавец создает запрос на проведение платежа /mir/paymentDirect.do, содержащий расшифрованные платежные данные, и отправляет его платежному шлюзу.
9. Платежный шлюз осуществляет оплату.
10. Платежный шлюз возвращает результат оплаты мерчанту.
11. Мерчант отображает результат оплаты клиенту.

API-запросы Mir Pay

Регистрация заказа Mir Pay Pay

Для регистрации и оплаты заказа используется запрос /mir/payment.do. Запрос доступен, если мерчант имеет соответствующее разрешение.

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

Дополнительные параметры, определяющие тип создаваемой связки и передаваемые в additionalParameters:

Возможные значения tii (Подробнее о типах связок, поддерживаемых платежным шлюзом, читайте здесь).

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

Блок data содержит следующие элементы.

Блок error содержит следующие элементы.

Примеры

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

curl --location 'https://vtb.rbsuat.com/payment/mir/payment.do' \
--header 'Content-Type: application/json' \
--data '{
    "username": "test_user",
    "password": "test_user_password",
    "orderNumber": 3229,
    "description": "description",
    "language": "RU",
    "tii" : "II",
    "clientId":"202403122",
    "additionalParameters": {
        "installments": "5",
        "recurringFrequency": "5",
        "recurringExpiry": "20241004"
    },
    "preAuth": false,
    "paymentToken": "eyJhbGciOiJSU0...9HDxLg",
    "ip": "127.0.0.1"
}'

Ответ в случае успешной оплаты

{
    "success": true,
    "data": {
        "orderId": "243ec139-4b5a-7859-b409-bbcb4806bc81",
        "bindingId": "7c1d7969-bf01-7f34-be04-c6904806bc81"
    }
}

Ответ в случае неудачной оплаты

{
  "error": {
    "code": 1,
    "description": "Processing Error",
    "message": "Insufficient amount on card"
  },
  "success": false
}

Mir Pay Direct

Запрос, используемый для осуществления прямого платежа через Mir Pay - /mir/paymentDirect.do. Запрос доступен, если мерчант имеет соответствующее разрешение.

Этот запрос можно использовать для интеграций, предполагающих расшифровку платежных данных на стороне продавца.

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

Дополнительные параметры, определяющие тип создаваемой связки и передаваемые в additionalParameters:

Возможные значения tii (Подробнее о типах связок, поддерживаемых платежным шлюзом, читайте здесь).

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

Блок data содержит следующие элементы.

Блок error содержит следующие элементы.

Примеры

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

curl --location 'https://vtb.rbsuat.com/payment/mir/paymentDirect.do' \
--header 'Content-Type: application/json' \
--data '{
    "username": "test_user",
    "password": "test_user_password",
    "orderNumber": 243ec139-4b5a-7859-b409-bbcb4806bc81,
    "description": "description",
    "language": "RU",
    "tii" : "II",
    "clientId":"202403112",
    "additionalParameters": {
        "installments": "5",
        "recurringFrequency": "5",
        "recurringExpiry": "20241231"
    },
    "preAuth": false,
    "paymentToken": "eyJ0YW4iOiIyMj...wifQ==",
    "ip": "127.0.0.1"
}'

Ответ в случае успешной оплаты

{
    "success": true,
    "data": {
        "orderId": "243ec139-4b5a-7859-b409-bbcb4806bc81",
        "bindingId": "7c1d7969-bf01-7f34-be04-c6904806bc81"
    }
}

Ответ в случае неудачной оплаты

{
  "error": {
    "code": 1,
    "description": "Processing Error",
    "message": "Insufficient amount on card"
  },
  "success": false
}