Mir Pay

Introduction

Mir payment system provides an opportunity to process payments from merchant's applications or mobile versions of websites with use of the Mir Pay service.

If you have a permission to store credentials, you can store credentials for further regular payments (recurrent or installment payments) during payment via Mir Pay.

The following sections describe the integration of the Mir Pay In-Application payment method.

To accept payments via Mir Pay, you must have this feature enabled for you.

Integration schemes

Payment page on Payment gateway side

1. The client forms an order on the merchant's website.
2. The merchant requests an order registration by sending an API request to the payment gateway:
   a. For one-phase payment - register.do API request;
   b. For two-phase payment - registerPreAuth.do API request.
3. The payment gateway registers an order and sends a response to the merchant containing the formUrl parameter (the payment URL to which the merchant should redirect the client) and  the orderId parameter (the unique order number in the payment gateway system).
4. The online store redirects the client to the URL received in the formUrl parameter.
5. The client's browser opens the received URL.
6. The payment page requests a list of possible payment methods from the payment gateway.
7. The payment gateway forms a Universal link.
8. The payment gateway returns the merchant's Mir Pay option and Universal link in the response.
9. The client receives a payment form with a rendered Mir Pay payment button.
10. The client selects Mir Pay payment method on the payment page.
11. The payment page launches Universal link on the client's device.
12. Mir Pay verifies the merchant's signature and involvement in the program.
13. Mir Pay displays a list of cards to the client.
14. The client selects a card for payment in the Mir Pay application.
15. Mir Pay redirects the client's browser to the payment page URL.
16. Mir Pay generates payment data and sends encrypted payment data to the payment gateway.
17. The payment gateway decodes the payment data.
18. The payment gateway processes the payment.
19. The client's browser accesses the payment page to receive the payment result.
20. The payment page requests the payment result from the payment gateway.
21. The payment gateway returns the payment result to the payment page.
22. The payment page displays the payment result to the client.

Payment page/Application on Merchant's side

Prerequisites

In order to accept Mir Pay payments via the payment gateway, when you leverage your own payment page/application to independently access Mir Pay, you must be issued an end certificate. Please contact the technical support service to obtain this certificate.

Along with the end certificate you should receive from the technical support service the following:

1. "Standard of the "Mir" payment system. Description of the implementation of Mir Pay Android In-Application operations for the merchant" document.
2. MirPaySDK.aar library for embedding in the merchant's mobile application.
3. API description in the a yaml-file format.
4. The URL of the merchant's end certificate file on the Aggregator's public Web resource (https://participant's host/juks/-juks.json), if this merchant supports In-Application Web-based operation technology.

1. The client selects the Mir Pay payment method on the merchant's payment page.
2. Merchant runs an In-Application operation preparation script via MirPaySDK in the Mir Pay application/Merchant runs an In-Application operation preparation script via Deeplink or Universal Link in the Mir Pay application.
3. Mir Pay verifies the merchant's signature and involvement in the program.
4. Mir Pay displays a list of cards to the client.
5. The client selects a card for payment in the Mir Pay application.
6. Mir Pay generates the payment data and sends the encrypted payment data to the merchant.
7. The merchant requests a payment by sending /mir/payment.do API request to the payment gateway .
8. The payment gateway decodes the payment data.
9. The payment gateway processes the payment.
10. The payment gateway returns the payment result to the merchant.
11. The merchant displays the payment result to the client.

Payment data decryption on Merchant's side

1. The client selects the Mir Pay payment method on the payment page.
2. Merchant runs an In-Application operation preparation script via MirPaySDK in the Mir Pay application/Merchant runs an In-Application operation preparation script via Deeplink or Universal Link in the Mir Pay application.
3. Mir Pay verifies the merchant's signature and involvement in the program.
4. Mir Pay displays a list of cards to the client.
5. The client selects a card for payment in the Mir Pay application.
6. Mir Pay generates the payment data and sends the encrypted payment data to the merchant.
7. The merchant decodes the payment data.
8. The merchantt creates a payment request /mir/paymentDirect.do containing the decrypted payment data and sends it to the payment gateway.
9. The payment gateway processes the payment.
10. The payment gateway returns the payment result to the merchant.
11. The merchant displays the payment result to the client.

Mir Pay API requests

Mir Pay order registration

The request used to register and pay for an order is https://mts.rbsuat.com/payment/mir/payment.do. The request call is available if the merchant is assigned a corresponding permission.

When sending the request, you should use the header: Content-Type: application/json

Request parameters

Additional parameters that specify the type of created stored credential and are passed in additionalParameters:

Possible values of tii (read about the stored credential types supported by the Payment Gateway here):

Response parameters

data block contains the following elements.

error block contains the following elements.

Examples

Request example

curl --location 'https://mts.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": "x.x.x.x"
}'

Response in case of a successful payment

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

Response in case of a failed payment

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

Mir Pay Direct

The request used to make a direct payment via Mir Pay is https://mts.rbsuat.com/payment/mir/paymentDirect.do. The request call is available if the merchant is assigned a corresponding permission.

When sending the request, you should use the header: Content-Type: application/json

This request can be used for integrations that involve payment data decoding on Merchant side.

Request parameters

Additional parameters that specify the type of created stored credential and are passed in additionalParameters:

Possible values of tii (read about the stored credential types supported by the Payment Gateway here):

Response parameters

data block contains the following elements.

error block contains the following elements.

Examples

Request example

curl --location 'https://mts.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": "x.x.x.x"
}'

Response in case of a successful payment

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

Response in case of a failed payment

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