Card payments via partner (in Ukraine for Privat24 and Monobank banks)

Interaction diagram

Payment processing by using the partner 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, UAH		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases					14,999.00		2 hours

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

In the partner method to perform a purchase operation, you need to redirect customer to the partner service.

The sections that follow provide detailed information about what you need to perform payments and how you can analyze the information on payments and operations.

General information

In the partner method, when processing a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the Monetix URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with one of the partner method selected. For more information about preselecting payment methods, see in Preselecting payment methods. The full sequence and particularities of the purchase process are 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 using 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 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.
2. The currency of payment can only be UAH.
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: mono for Monobank, privat24 for Privat24.
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 purchase request.

    { project_id: 211,
      payment_id: 'X03936',
      payment_currency: 'UAH',
      payment_amount: 1000,
      customer_id: '123',
      customer_first_name: 'John', 
      customer_last_name: 'Doe',
      customer_email: 'johndoe@example.com', 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }

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

Callback format

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

The following is the example of a callback with an information about successful 22.00 UAH purchase made in the 5111 project.

{
        "project_id": 5111,
        "payment": {
            "id": "EPb8dd-037f",
            "type": "purchase",
            "status": "success",
            "date": "2021-04-07T09:10:56+0000",
            "method": "Card partner",
            "sum": {
                "amount": 2200,
                "currency": "UAH"
            },
            "description": ""
        },
        "account": {
            "number": "444111******1715"
        },
        "operation": {
            "id": 50167,
            "type": "sale",
            "status": "success",
            "date": "2021-04-07T09:10:56+0000",
            "created_date": "2021-04-07T09:10:08+0000",
            "request_id": "0e452c15b415b527c6c48d5a60c1bfa6-00000001",
            "sum_initial": {
                "amount": 2200,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 2200,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2977,
                "payment_id": "422531",
                "auth_code": "",
                "date": "2021-04-07T12:10:47+0000"
            }
        },
        "signature": "nmVDQe1Rm8qSZY+ExLGh/i6zHpZd3NQ=="

The following is the example of a callback for a declined purchase.

{
        "project_id": 5111,
        "payment": {
            "id": "EPac83-931f",
            "type": "purchase",
            "status": "decline",
            "date": "2021-04-07T09:19:14+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100,
                "currency": "UAH"
            },
            "description": ""
        },
        "account": {
            "number": "444111******1715"
        },
        "operation": {
            "id": 50168,
            "type": "sale",
            "status": "decline",
            "date": "2021-04-07T09:19:14+0000",
            "created_date": "2021-04-07T09:18:36+0000",
            "request_id": "561d1fb027ee6e41b0a638c12562c42b4e7-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2976,
                "payment_id": "422532",
                "auth_code": "",
                "date": "2021-04-07T12:19:01+0000"
            }
        },
        "signature": "YC915KBHiwf105skFF8ELyUlGj/AzpYH5AjSUVr0a6A=="
    }

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 partner 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. Perform the redirection of a customer to the partner service.
3. Get 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. For general information on how to use the API, see API Description.

Request format

1. You send purchase requests by sending the /v2/payment/card-partner/sale request by using the POST HTTP method.
2. The following objects and parameters must be specified in any request:
   • general—object with general purchase information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
   • payment—object with payment details:
     • amount—purchase 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.
     • currency—payment currency in the ISO-4217 alpha-3 format
     • extra_param—in order to make purchases by using this method one of the following values must be specified: mono for Monobank, privat24 for Privat24
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • 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.
     • return—the URL to redirect the customer to when they prematurely terminate the payment.
3. The currency of purchase can only be UAH.
4. 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": 211,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
        "amount": 1000,
        "currency": "UAH",
        "extra_param": "mono"
    },
    "customer": {
        "id": "123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@email.com"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    } 
}

Format of 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

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

The following is the example of a callback with an information about successful 22.00 UAH purchase made in the 5111 project.

{
        "project_id": 5111,
        "payment": {
            "id": "EPb8dd-037f",
            "type": "purchase",
            "status": "success",
            "date": "2021-04-07T09:10:56+0000",
            "method": "Card partner",
            "sum": {
                "amount": 2200,
                "currency": "UAH"
            },
            "description": ""
        },
        "account": {
            "number": "444111******1715"
        },
        "operation": {
            "id": 50167,
            "type": "sale",
            "status": "success",
            "date": "2021-04-07T09:10:56+0000",
            "created_date": "2021-04-07T09:10:08+0000",
            "request_id": "0e452c15b415b527c6c48d5a60c1bfa6-00000001",
            "sum_initial": {
                "amount": 2200,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 2200,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2977,
                "payment_id": "422531",
                "auth_code": "",
                "date": "2021-04-07T12:10:47+0000"
            }
        },
        "signature": "nmVDQe1Rm8qSZY+ExLGh/i6zHpZd3NQ=="

The following is the example of a callback for a declined purchase.

{
        "project_id": 5111,
        "payment": {
            "id": "EPac83-931f",
            "type": "purchase",
            "status": "decline",
            "date": "2021-04-07T09:19:14+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100,
                "currency": "UAH"
            },
            "description": ""
        },
        "account": {
            "number": "444111******1715"
        },
        "operation": {
            "id": 50168,
            "type": "sale",
            "status": "decline",
            "date": "2021-04-07T09:19:14+0000",
            "created_date": "2021-04-07T09:18:36+0000",
            "request_id": "561d1fb027ee6e41b0a638c12562c42b4e7-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2976,
                "payment_id": "422532",
                "auth_code": "",
                "date": "2021-04-07T12:19:01+0000"
            }
        },
        "signature": "YC915KBHiwf105skFF8ELyUlGj/AzpYH5AjSUVr0a6A=="
    }

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

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.