Payments by using Apple Pay and Google Pay via partner (in Kazakhstan)

Overview

This payment method allows to process payments by using the Apple Pay and Google Pay services via the partner's service. You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type Contactless payments
Countries and regions KZ
Payment currencies KZT
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations

in order to avoid errors during payment processing by using Payment Page it is necessary to preselect the payment method

Obtaining access to the payment method and access fee refer to your ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts, KZT Times*
Payment Page CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Purchases + + 1-3 minutes 20 minutes

* The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

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 analyse the information on payments and operations.

Purchase by using Payment Page

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



Figure: Purchase sequence in the Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the method or agrees to use the method if the method was preselected.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the partner service.
  10. The purchase request is processed on the partner service side.
  11. The partner service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the partner website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the partner side.
  16. The result is displayed to the customer on the partner website.
  17. The customer is redirected to Payment Page.
  18. The partner service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

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:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—the ID of the customer within the project
  2. The currency of payment can only be KZT.
  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.

Thus, a correct payment request in the method must include project, customer and payment IDs, the currency and the payment amount, parameters for preselecting the payment method, as well as signature, as shown in the following example:

    { 
      project_id: 211,
      payment_id: 'X03936',
      payment_currency: 'KZT',
      payment_amount: 1000, 
      customer_id: '123',
      force_payment_method: 'card-token-partner',
      payment_extra_param: 'googlepay-partner',
      signature: "kUi2x9dKHAVNU0FYldJryo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/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.

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

Figure: Example of a successful purchase callback

{
        "project_id": 21642,
        "payment": {
            "id": "EPaf5c-bb86",
            "type": "purchase",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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.

Figure: Example of a declined purchase callback

{
        "project_id": 21642,
        "payment": {
            "id": "EP6fc5-d018",
            "type": "purchase",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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:

Purchase by using Gate

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



Figure: Purchase by using Gate

  1. A customer initiates a purchase on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the partner service.
  7. The request is processed on the partner side.
  8. The partner service sends the data for redirecting the customer to the partner service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the partner service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the partner side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The partner service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

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

There are several things you must consider when using purchase requests in the method:
  1. You send purchase requests by sending the /v2/payment/card-token-partner/sale request by using the POST HTTP method.
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—the project ID obtained from ECommPay
      • 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
    • Object payment—purchase information:
      • amount—purchase amount in minor units
      • 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: googlepay-partner for purchase via Google Pay, applepay-partner for purchase via Apple Pay
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
  3. The currency of purchase can only be KZT.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in this method must include project, customer and payment IDs, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
      "project_id": 211,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7fBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "KZT",
      "extra_param": "googlepay-partner"
    },
    "customer": {
      "id": "123",
      "ip_address": "1.1.1.1"
    } 
}

Formats of the customer redirection data

To redirect a customer from the web service to the partner site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the token for purchase.

{
 "redirect_data": {
    "method": "GET",
    "url": "https://pay.example.com/3e919456-dbd6-11eb-ace3-b2c89b221bfd"
  }
}

Callback format

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

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

Figure: Example of a successful purchase callback

{
        "project_id": 21642,
        "payment": {
            "id": "EPaf5c-bb86",
            "type": "purchase",
            "status": "success",
            "date": "2021-07-14T08:09:50+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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.

Figure: Example of a declined purchase callback

{
        "project_id": 21642,
        "payment": {
            "id": "EP6fc5-d018",
            "type": "purchase",
            "status": "decline",
            "date": "2021-07-14T08:14:55+0000",
            "method": "CardTokenPartner",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "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:

Analysis of payments results

As with other payment methods ECommPay offers, when using the partner method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard (Old Dashboard), 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 (Old 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 ECommPay technical support.