Card payments via partner (Russia)

Interaction diagram

Payment processing by using the payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as partner technical facilities.

Operations support

	Interfaces			Amounts, RUB
	Payment Page	Gate	Dashboard	minimum	maximum
Purchases				*	*
Payouts				*	*

* For the most recent amount limits, contact your Monetix key account manager.

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

To perform a purchase operation, you need to redirect customer to the partner's service, while to initiate a payout, you need to notify customer via merchant's web service.

General information

In the method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the method pre-selected. (For more information about pre-selecting payment methods, see Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

     Depending on the payment processing partner, you may be required to round the amount to an integer value, the rounding decision is made on the merchant side. For example, for the amount 100.05 (RUB) two values can be specified 10000 or 10100. Refer to your Monetix key account manager for more information.

2. The currency of payment can only be RUB.
3. If you need to have payment form displayed with the method selected, set the force_payment_method parameter to card-partner and the payment_extra_param parameter to one of the following values (depending on the payment processing partner): mobi-card or p2p.
4. If required, you can also add any other additional parameters Payment Page supports.
5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    { 
        payment_id: 'X03936', 
        payment_amount: 10000, 
        payment_currency: 'RUB', 
        customer_id: '123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',
        project_id: 250, 
        signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the method, see Payment Page invocation parameters.

Callback format

This method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.

Depending on the payment processing partner the card number of the customer is specified in the callback in the number parameter of the account object.

The following is the example of a callback with an information about successful 100.00 RUB purchase from card 553691******0802 made by the customer_10 customer in the 874 project.

{
    {
        "project_id": 874,
        "payment": {
            "id": "3013",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-24T11:08:49+0000",
            "method": "Card partner",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "sale"
        },
        "account": {
            "number": "553691******0802" // is used depending on the partner
        },
        "customer": {
            "id": "customer_10"
        },
        "operation": {
            "id": 14,
            "type": "sale",
            "status": "success",
            "date": "2019-06-24T11:08:49+0000",
            "created_date": "2019-06-24T11:07:42+0000",
            "request_id": "71228f54d21e776a481",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1496,
                "payment_id": "60-1c6072de6000",
                "date": "2019-06-24T11:08:47+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "+GTEzb3Xw4A9Ap8q/LE8TyyJM+MEXXja28RXtr8v2EITaK4UzSgifLxgB6c9TSeb/peLxw=="
    }
}

The following is the example of a callback for a purchase declined due to inappropriate payment currency.

{
    {
        "project_id": 874,
        "payment": {
            "id": "3014",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-24T11:12:34+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "sale"
        },
        "customer": {
            "id": "customer_10"
        },
        "operation": {
            "id": 2000000013,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-24T11:12:35+0000",
            "created_date": "2019-06-24T11:11:57+0000",
            "request_id": "10b3228392a76024",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1496,
                "payment_id": "8a14-4da680069d1e",
                "date": "2019-06-24T11:12:33+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "gExJfJirZithIopm68xkJAty50SAH1F3u/wqC1geqM9N9hO0DLej2pJJm8kZZo6ZfGxrWw=="
    }
}

Related topics

The following topics might be useful when implementing payments by using Payment Page:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

In the method, when processing a purchase by using Gate, the merchant web service is required to do the following:

1. Send a request with all the required parameters and signature to the Monetix URL.
2. Redirect the customer to the partner service.
3. Accept the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the /v2/payment/card-partner/sale request by using HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID you obtained from Monetix
     • payment_id—payment ID unique within the project
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
   • payment—object with purchase information:
     • amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

       Depending on the payment processing partner, you may be required to round the amount to an integer value, the rounding decision is made on the merchant side. For example, for the amount 100.05 (RUB) the rounded value may be either 10000 or 10100. Refer to your Monetix key account manager for details.

     • currency—code of purchase currency in the ISO-4217 alpha-3 format
     • extra_param—additional parameter. To perform purchases the value must be specified to one of the following (depending on the payment processing partner) mobi-card or p2p.
   • card—object with customer card information:
     • pan—customer card number. This parameter may be passed either in initial request or in the process of additional payment information submission. For more information about additional information submission, see Submission of additional payment information. Refer to you Key Account Manager at Monetix to learn whether this parameter is required.
   • return_url—object with URL(s) to return the customer to the web service:
     • return—URL for redirecting the customer during any step of the purchase. This parameter may not be mandatory. Refer to you Key Account Manager at Monetix for details.
3. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed.
     • decline—the URL to redirect the customer to after the payment is declined.
4. The currency of purchase can only be RUB.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request.

{ 
   "general": { 
      "project_id": 874,
      "payment_id": "561719496",
      "signature": "fCkXYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4BmNB2sVcrW0r3wcXQggExZHbeXH/VPAMbywQ=="
   },
   "customer": { 
      "id": "customer_test",
      "ip_address": "198.51.100.47",
      "first_name": "John",
      "last_name": "Doe",
      "email": "johndoe@example.com"
   },
   "card": {
      "pan": "621661******6793"
   },
   "payment": { 
      "amount": 1000,
      "currency": "RUB",
      "extra_param": "mobi-card"
   },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
   }
}

Formats of the customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the partner service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

This method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

Depending on the payment processing partner the card number of the customer is specified in the callback in the number parameter of the account object.

The following is the example of a callback with an information about successful 100.00 RUB purchase from card 553691******0802 made by the customer_10 customer in the 874 project.

{
    {
        "project_id": 874,
        "payment": {
            "id": "3013",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-24T11:08:49+0000",
            "method": "Card partner",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": "sale"
        },
        "account": {
            "number": "553691******0802" // is used depending on the partner
        },
        "customer": {
            "id": "customer_10"
        },
        "operation": {
            "id": 14,
            "type": "sale",
            "status": "success",
            "date": "2019-06-24T11:08:49+0000",
            "created_date": "2019-06-24T11:07:42+0000",
            "request_id": "71228f54d21e776a481",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1496,
                "payment_id": "60-1c6072de6000",
                "date": "2019-06-24T11:08:47+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "+GTEzb3Xw4A9Ap8q/LE8TyyJM+MEXXja28RXtr8v2EITaK4UzSgifLxgB6c9TSeb/peLxw=="
    }
}

The following is the example of a callback for a purchase declined due to inappropriate payment currency.

{
    {
        "project_id": 874,
        "payment": {
            "id": "3014",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-24T11:12:34+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "sale"
        },
        "customer": {
            "id": "customer_10"
        },
        "operation": {
            "id": 2000000013,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-24T11:12:35+0000",
            "created_date": "2019-06-24T11:11:57+0000",
            "request_id": "10b3228392a76024",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1496,
                "payment_id": "8a14-4da680069d1e",
                "date": "2019-06-24T11:12:33+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "gExJfJirZithIopm68xkJAty50SAH1F3u/wqC1geqM9N9hO0DLej2pJJm8kZZo6ZfGxrWw=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

To perform a payout through the partner method, merchant's web service sends a request with all the required parameters and signature to Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

For the information on the format of requests and parameters for initiating payouts by using Gate, as well as on the format of callbacks with the payout results, see Payout by card. For general information on using the API, see API Description.

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.