Payments by using Apple Pay and Google Pay via partner

Interaction diagram

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

Operations support

	Interfaces			Times
	Payment Page	Gate	Dashboard	basic	threshold
Purchases				1-3 minutes	24 hours
Full refunds		*	*	1 business day according to the partner's schedule	3 business days according to the partner's schedule

* For obtaining access to the full refunds refer to 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

In the partner method, purchases and refunds follow different processing procedures. To perform a purchase operation, you need to redirect the customer to the partner service, while to initiate a refund, you need to notify the customer via the merchant's web service.

Supported countries

The table below provides information on the countries supported in the Apple Pay and Google Pay via partner payment methods and their amount currencies and limits. For the information on which of the countries are relevant to you, refer to your Monetix key account manager.

General information

In this 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 the 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 required for any payment method:
   • project_id—project ID you obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—the unique ID of the customer within your project
   • customer_email—customer email. In some cases, if this parameter is missing from the request, Payment Page will contain an additional field for the customer to enter an email. For more information about additional information submission, see Submission of additional payment information. Refer to your Monetix Key Account Manager to find out whether the additional submission of this parameter is relevant to you.
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • 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. It is also recommended to specify the phone number of the customer in the customer_phone parameter. Refer to your Monetix key account manager to find out whether this parameter is relevant to you.
3. It is necessary to preselect the payment method. To preselect the method, set the force_payment_method parameter to card-token-partner and the payment_extra_param parameter to one of the following values: googlepay-partner for payment via Google Pay, applepay-partner for payment via Apple Pay.
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(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'UAH',
        payment_amount: 1000,   
        force_payment_method: 'card-token-partner',
        payment_extra_param: 'googlepay-partner', 
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the 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 10.00 UAH purchase made in the 21642 project.

{
        "project_id": 21642,
        "payment": {
            "id": "EPaf5c-bb86",
            "type": "purchase",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 79,
            "type": "sale",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "created_date": "2021-07-14T08:09:22+0000",
            "request_id": "f2b75ca5a37f866d963758bca6bd780e6fe21e34db70263da51-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8212,
                "payment_id": "1626250167333",
                "auth_code": "",
                "date": "2021-07-14T08:09:49+0000"
            }
        },
        "signature": "uxni0BcXNiDHG4pbrPESXvT3aRkgVcO1ub/brcmd2/UyupKwSKrZViv6SDfw=="
    }

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

{
        "project_id": 21642,
        "payment": {
            "id": "EP6fc5-d018",
            "type": "purchase",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 80,
            "type": "sale",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "created_date": "2021-07-14T08:14:36+0000",
            "request_id": "e6c8ff790de747a8805fb18c081f0a6f862a6317aa-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8212,
                "payment_id": "1626250480849",
                "auth_code": "",
                "date": "2021-07-14T08:14:53+0000"
            }
        },
        "signature": "A4rWZS0rm7y2sbQ2BAwZyxEjMADdXrhOXDexVah9N796BxKs+SsO0fBOh/qfVg=="
    }

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 this 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 partner payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You initiate a purchase by submitting a purchase request to the /v2/payment/card-token-partner/sale endpoint by using the 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
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • email—customer email. In some cases, this parameter may be passed either in the initial request or in the process of additional payment information submission. For more information about the additional information submission, see Submission of additional payment information. Refer to your Monetix Key Account Manager to find out whether the additional submission of this parameter is relevant to you.
     • first_name—customer first name
     • last_name—customer last name
   • payment—object with purchase information:
     • 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—code of purchase 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: googlepay-partner for purchase via Google Pay, applepay-partner for purchase via Apple Pay
3. It is also recommended to specify the phone number of the customer in the customer.phone parameter. Refer to your Monetix key account manager to find out whether this parameter is relevant to you.
4. 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.
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the partner method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 1000,
        "currency": "UAH",
        "extra_param": "googlepay-partner"
    },
    "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 provider 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 10.00 UAH purchase made in the 21642 project.

{
        "project_id": 21642,
        "payment": {
            "id": "EPaf5c-bb86",
            "type": "purchase",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 79,
            "type": "sale",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "created_date": "2021-07-14T08:09:22+0000",
            "request_id": "f2b75ca5a37f866d963758be34db70263da51-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8212,
                "payment_id": "1626250167333",
                "auth_code": "",
                "date": "2021-07-14T08:09:49+0000"
            }
        },
        "signature": "uxni0BcXNiDHG4pbrPVcO1ub/brcmd2/UyupKwSKrZViv6SDfw=="
    }

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

{
        "project_id": 21642,
        "payment": {
            "id": "EP6fc5-d018",
            "type": "purchase",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 80,
            "type": "sale",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "created_date": "2021-07-14T08:14:36+0000",
            "request_id": "e6c8ff790de747a8805fb18c081f0a6f862a6317aa-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8212,
                "payment_id": "1626250480849",
                "auth_code": "",
                "date": "2021-07-14T08:14:53+0000"
            }
        },
        "signature": "A4rWZS0rm7y2sbQ2BAwZyxEjXDexVah9N796BxKs+SsO0fBOh/qfVg=="
    }

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

This method supports full refunds processing. In the method, any refund follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to Monetix URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.

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

Request format

1. You perform a refund by sending the request to the /v2/payment/card-token-partner/refund endpoint by using the HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object with general refund information:
     • project_id—project identifier
     • payment_id—unique refund identifier
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
   • payment—object with refund information:
     • description—comment or description
3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a refund request in the partner method.

  "general": {    
    "project_id": 211,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },
  "payment": {
    "description": "refund"
  }

Callback format

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

The following is the example of a callback with an information about successful 10.00 UAH refund made in the 21642 project.

{
        "project_id": 21642,
        "payment": {
            "id": "EPaf5c-bb86",
            "type": "purchase",
            "status": "refunded",
            "date": "2021-07-14T08:26:06+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 0,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 82,
            "type": "refund",
            "status": "success",
            "date": "2021-07-14T08:26:06+0000",
            "created_date": "2021-07-14T08:25:56+0000",
            "request_id": "a1076ed5f120a3957922c7dded307124f82d0ba32af8-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 8212,
                "payment_id": "1626250167333",
                "auth_code": "",
                "date": "2021-07-14T08:26:03+0000"
            }
        },
        "signature": "/nWsfWG8LFlhOW8SfM+Q0Ccky0Njq8MDlVk0VU3fuS9OzhRQ8bbIbd2BmPA=="
    }

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

{
        "project_id": 21642,
        "payment": {
            "id": "EP2534-62ee",
            "type": "purchase",
            "status": "success",
            "date": "2021-07-14T08:32:14+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1200000,
                "currency": "UAH"
            },
            "description": ""
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 83,
            "type": "refund",
            "status": "decline",
            "date": "2021-07-14T08:32:14+0000",
            "created_date": "2021-07-14T08:32:07+0000",
            "request_id": "2480d11490ec7e57b3746304378c0527fdc2afdfe1e-00000001",
            "sum_initial": {
                "amount": 1200000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 1200000,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 8213,
                "payment_id": "1626250821188",
                "auth_code": "",
                "date": "2021-07-14T08:32:12+0000"
            }
        },
        "signature": "qYapuEvPmmAmC+vZKH7gp3oEzzsq7K6anQ9/UH4A/HBbHClg5jTfJrRFaQ=="
    }

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.