Payments by using Apple Pay and Google Pay via partner - Purchase

When performing a purchase, the customer is redirected to the provider service where they make a purchase.


Countries and regions	The list of available countries is provided in the Supported countries section
Payment currencies	EUR, UAH, USD
Payment amount limits	Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time	Contact your key account manager at Monetix for details.
Currency conversion	On the Monetix side
Refund
Onboarding and access fee	Contact your key account manager at Monetix for details.
Special considerations In order to avoid errors during the payment processing it is recommended: when processing purchases by using Payment Page, it is necessary to preselect the payment method configure your system to check whether the customer's device supports the possibility of paying via Apple Pay or Google Pay Note: Ask your key account manager at Monetix whether the following payment processing considerations are relevant to you. In some cases with the Apple Pay payments there are following limits: the total amount of all purchases where customers have to authorize using their emails must be not more than 50,000.00 EUR per month a customer can use not more than three cards per one email per month. If the customer uses the same card with different emails, the purchase is automatically declined on the provider service side when performing the purchase by using Gate, the opening of the payment page of the selected payment method is possible only in the new window if the customer does not complete all the steps required for the payment within 1 hour after it was initiated, the payment is automatically declined on the partner side

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase
Refund

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

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.

Table 1. Supported countries and their payment amount limits
Payment method	Countries	Currencies	Amounts
Payment method	Countries	Currencies	minimum	maximum
Apple Pay via partner	Austria, Belgium, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Liechtenstein, Lithuania, Luxembourg, Malta, Netherlands, Norway, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, United Kingdom	EUR, USD	1.00	10,000.00
Apple Pay via partner	Ukraine	UAH	5.00	145,000.00
Google Pay via partner	Ukraine	UAH	5.00	145,000.00

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Payments by using Apple Pay and Google Pay via partner payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Payments by using Apple Pay and Google Pay via partner payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Payments by using Apple Pay and Google Pay via partner payment method.
The checkout page redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Payments by using Apple Pay and Google Pay via partner payment method.

strictly required—the parameter must be in the initial request.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

customer_phone
string
strictly required✱

Customer phone number without a plus sign (+), spaces and punctuation.

Example: 593123456789

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: UAH

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 UAH must be sent as 10000

force_payment_method
string
strictly required

Parameter that allows you to enforce the Payments by using Apple Pay and Google Pay via partner payment method for your customer and skip the page with payment method selections.

To enforce the Payments by using Apple Pay and Google Pay via partner payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to card-token-partner together with the payment_extra_param parameter. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'card-token-partner'

payment_extra_param
string
strictly required

Additional parameter that allows you to enforce the Payments by using Apple Pay and Google Pay via partner payment method for your customer and skip the page with payment method selections.

Possible values:

googlepay-partner—for payment via Google Pay
applepay-partner—for payment via Apple Pay

Example: applepay-partner

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

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',
		customer_phone: '593123456789',
		payment_currency: 'UAH',
		payment_amount: 10000,
		force_payment_method: 'card-token-partner',
		payment_extra_param: 'applepay-partner',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Payments by using Apple Pay and Google Pay via partner payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 10000,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 10000,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Payments by using Apple Pay and Google Pay via partner payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Redirect the customer to the provider service.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Payments by using Apple Pay and Google Pay via partner payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the Monetix payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
The payment platform generates the data for redirecting the customer to the provider service and sends the data to your system in the redirect_data object.
Your system redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected to your system.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Payments by using Apple Pay and Google Pay via partner payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/card-token-partner/sale

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

phone
string
strictly required✱

Customer phone number without a plus sign (+), spaces and punctuation.

Example: 593123456789

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: UAH

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 100.00 UAH must be sent as 10000

extra_param
string
strictly required

Additional parameter, required to make purchases by using this method.

Possible values:

googlepay-partner—for payment via Google Pay
applepay-partner—for payment via Apple Pay

Example: applepay-partner

return_url
object
optional

success
string
optional

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

return
string
optional

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. 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.

Example: https://example.com/return/

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Payments by using Apple Pay and Google Pay via partner payment method:

Figure 5. Example of the purchase request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone": "593123456789"
    },
    "payment": {
        "currency": "UAH",
        "amount": 10000,
        "extra_param": "applepay-partner"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting 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 send in the request body
method—the HTTP method for retrieving the website page (for example, POST or GET)
encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with the data to redirect the customer.

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

Callback

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 10000,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 10000,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Refund by using Gate

General information

To perform a refund by using Gate for a purchase made with the Payments by using Apple Pay and Google Pay via partner payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the refund result from the payment platform.

The following picture provides all the details of the refund processing flow in the Payments by using Apple Pay and Google Pay via partner payment method.

Figure 8. Refund processing flow when performing a refund by using Gate

The customer initiates a refund in your system.
Your system sends the refund request to the Monetix payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
The payment platform processes the request and forwards it to the provider service.
The provider service informs the payment platform about the refund result.
The payment platform sends you the callback with the refund result.
Your system sends the refund result to the customer.

Request

This section provides the instructions on how to build the request for refund with the Payments by using Apple Pay and Google Pay via partner payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/card-token-partner/refund

strictly required—the parameter must be in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

ID of the payment the refund is performed for

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

description
string
strictly required

Refund description.

Example: Refund description.

You can also add any other optional parameters to the refund request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a refund with the Payments by using Apple Pay and Google Pay via partner payment method:

Figure 9. Example of the refund request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "payment": {
        "description": "Refund."
    }
}

Callback

In the Payments by using Apple Pay and Google Pay via partner payment method, the payment platform returns the refund result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed refund.

Figure 10. Example of the body of a successful refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "refunded",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 0,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 11. Example of the data from a declined refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "card-token-partner",
        "sum": {
            "amount": 10000,
            "currency": "UAH"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "UAH"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "UAH"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Payments by using Apple Pay and Google Pay via partner - Purchase

Operations support

Supported countries

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Customer redirection

Callback

Related topics

Refund by using Gate

General information

Request

Callback

Related topics