Mobile Commerce in Ukraine

Overview

Mobile Commerce in Ukraine is a payment method which allows processing payments by using mobile billing in Ukraine. Purchases can be processed by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type mobile commerce
Countries and regions UA
Payment currencies
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes the following network operators are supported:
  • purchases—Kyivstar
  • payouts:
    • Kyivstar
    • lifecell
    • Vodafone
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts, UAH Times**
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + * * * *
Payouts + + * * * *

* For more information refer to your ECommPay key account manager.

** 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 and the moment the initiator receives the callback with the payment result. 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 reacting to the absence of payment result callbacks or when checking payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform and the moment the initiator receives the callback with the payment result. A payment is automatically declined if its waiting time exceeds the threshold time. If you need a customised threshold time limit, contact ECommPay technical support.

Processing scenarios

When purchases are performed, the funds are debited from the customer's mobile phone account, while funds are credited to the customers' mobile phone accounts as a result of payouts.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Figure: Payout by using Gate



Supported mobile operators

Payments through the Mobile Commerce in Ukraine method are carried out through supported network operators. Operators have their own identifiers, which are used to initiate payouts by using Gate.

Table 1. Supported network operators
Network operator ID
Kyivstar KYIVSTAR
lifecell LIFECELL
Vodafone VODAFONE

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.

Purchases by using Payment Page

General information

In the Mobile Commerce in Ukraine method, when processing a purchase by using Payment Page, the merchant web service should send a request with the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. The Mobile Commerce in Ukraine payment method can be preselected when Payment Page is opened. For more information, see Preselecting payment method. The full sequence and particularities of the purchase process are provided below.



Figure: Purchase by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The merchant web service sends to the specified ECommPay URL the purchase request for processing the purchase by using Payment Page.
  3. The payment platform receives the request for processing the purchase by using Payment Page.
  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 Mobile Commerce in Ukraine method.
  8. The phone number input form is displayed to the customer.
  9. The customer enters the phone number.
  10. The payment platform receives the purchase request for payment processing from Payment Page.
  11. The payment platform performs the internal purchase request processing and sends it to the provider service.
  12. The purchase request is processed on the provider service side.
  13. The SMS with the payment confirmation code is sent to the customer from the provider side.
  14. The confirmation code input form is displayed to the customer on Payment Page.
  15. The customer enters the confirmation code on Payment Page and confirms the purchase. According to the operation protocol of the provider the customer must enter the confirmation code within 15 minutes. The SMS with the confirmation code is only sent once from the provider side.
  16. The payment is processed on the provider side.
  17. The provider service sends the result notification to the payment platform.
  18. The payment platform sends a callback with the payment result to the web service.
  19. The payment platform sends the result to Payment Page.
  20. 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 Mobile Commerce in Ukraine 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

When using the Mobile Commerce in Ukraine method, consider the following:

  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 code in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—the ID of the customer within your project
  2. If you need to have payment form displayed with the Mobile Commerce in Ukraine method selected, set the force_payment_method parameter to mobile.
  3. If the customer_phone parameter is used in the request, the phone number in the value of the parameter must be specified using a country code and without the + sign, for example 3800971234567. If the parameter is used in the request, the specified value is displayed to the customer in the phone number input form on Payment Page.
  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 Mobile Commerce in Ukraine method must include project, customer, and payment IDs, the currency code and the amount of a payment, as well as the signature as shown in the following example:

    { 
      project_id: 12,
      payment_id: 'X03936', 
      payment_currency: 'UAH', 
      payment_amount: 1000, 
      customer_id: '123',
      signature: "kUi2x9dKHAVNU0FYldJrxRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

Callback format

The Mobile Commerce in Ukraine 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 information about a successful 332.00 UAH purchase by using the phone number 3800971234567 made by the customer customer1 in the project 2664.

Figure: Example of data in a successful purchase callback

{
        "project_id": 2664,
        "payment": {
            "id": "S0332_20200710_133159_73006807",
            "type": "purchase",
            "status": "success",
            "date": "2020-07-10T10:32:32+0000",
            "method": "mobile",
            "sum": {
                "amount": 33200,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800971234567"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 711,
            "type": "sale",
            "status": "success",
            "date": "2020-07-10T10:32:32+0000",
            "created_date": "2020-07-10T10:31:59+0000",
            "request_id": "eaccec8fcdefa3c6e3825e...2d646369c1-00000001",
            "sum_initial": {
                "amount": 33200,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 33200,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2223,
                "payment_id": "15943771212",
                "auth_code": ""
            }
        },
        "signature": "py7aBmHSdibbtc6ALYnPcQV7zkY...GQWeRRwlOMtKI6m+81aWvpEwQ=="
    }

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

Figure: Example of data in a declined purchase callback

{
        "project_id": 2664,
        "payment": {
            "id": "D0320_20200710_134338_67886731",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-10T10:43:51+0000",
            "method": "mobile",
            "sum": {
                "amount": 32000,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800971234567"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 764,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-10T10:43:51+0000",
            "created_date": "2020-07-10T10:43:38+0000",
            "request_id": "18bc2e7b37883c787d37...f5854ec75a4e1eff41874-00000001",
            "sum_initial": {
                "amount": 32000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 32000,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2223,
                "payment_id": "15943778211",
                "auth_code": ""
            }
        },
        "signature": "2T6qRAdB2zPtWqLqmgvzNso1h...VUc1SIM419KlEIFSoQ=="
    }

Related topics

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

Purchases by using Gate

General information

In the Mobile Commerce in Ukraine 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. Receive the additional payment information callback and send the request with the required data to continue the payment. For more details, see Additional payment information submission.
  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 through Mobile Commerce in Ukraine 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 validity 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 provider service.
  7. The purchase request is processed on the provider service side.
  8. The provider sends the additional payment information callback to the payment platform.
  9. The payment platform sends the additional payment information callback to the web service.
  10. The SMS with the payment confirmation code is sent to the customer from the provider side.
  11. The confirmation code input form is displayed to the customer on the web service side.
  12. The customer enters confirmation code on the web service side and confirms the purchase. According to the operation protocol of the provider the customer must enter the confirmation code within 15 minutes. The SMS with the confirmation code is only sent once from the provider side.
  13. The web service sends the POST request containing the code to the payment platform.
  14. The payment platform performs further request processing that includes validation of the required parameters and signature.
  15. The purchase request is sent from the payment platform to the provider service.
  16. The payment is processed on the provider side.
  17. The provider service sends the payment result notification to the payment platform.
  18. The payment platform sends a callback to the web service.
  19. The customer receives the payment result from the web service.

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

Request format

When sending purchase requests in the Mobile Commerce in Ukraine method, consider the following:

  1. You perform purchases by sending the request to the /v2/payment/mobile/sale endpoint by using the POST HTTP method.
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature generated after all of the required parameters are specified. For more information about signature generation, see Signature generation and verification.
    • Object payment—purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier on the web service side
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer phone number associated with the account to be debited, for example 3800671234567 (the number must be specified with the country code and without the + sign)
  3. If required, you can also add any other additional parameters Gate supports.
  4. 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 Mobile Commerce in Ukraine method must include project and payment IDs, the currency code and the amount of a payment, customer and account information, as well as the signature as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 382,
    "payment_id": "e16d0d998485698c652f96f6b2ff8826",
    "signature": "3zjYFqRhDsaTLF7FVv4yu+Zie3x/...wG8JuRey87Q4Oyb3FzF+2uWs1Ka"
  },
  "customer": {
    "id": "123",
    "ip_address": "66.249.79.102"
  },
  "payment": {
    "amount": 1000,
    "currency": "UAH"
  },
  "account": {
    "number": "3800971234567"
  }
}

Format of requests for additional payment information submission

In order to submit additional payment information, the web service needs to receive the appropriate callback from the payment platform, send a POST request with the required information to the /v2/payment/clarification endpoint and receive a 200 OK response from the platform.

The callback contains the clarification_fields array which contains the parameter confirmation_code—payment confirmation code which the customer specifies on the web service side.

The following example of the callback fragment contains the information which is required to continue the payment.

{
  "clarification_fields": [
    "confirmation_code"
  ],
}

The web service needs to submit the requested additional payment information in a request to the /v2/payment/clarification endpoint by using the POST HTTP method. The request must contain the following objects and parameters:

  • general—object that contains general request identification information:
    • project_id—the project ID which is relevant to the payment
    • payment_id—payment ID which is relevant to the data being sent
    • signature—signature generated after all of the required parameters are specified. For more information about signature generation, see Signature generation and verification.
  • additional_data—object that contains additional payment information that payment platform requests:
    • confirmation_code—payment confirmation code, which the customer enters on the web service side

Thus, a correct request must include project and payment IDs, signature and payment confirmation code:

{
  "general": {
    "project_id": 11,
    "payment_id": "EPr-bf14",
    "signature": "v7KNMpfogAthg1ZZ5D/aZAeb0VMdeR+CqghwSm...=="
  },
  "additional_data": {
    "confirmation_code": "12345"
  }
}

Callback format

The Mobile Commerce in Ukraine 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 information about a successful 332.00 UAH purchase by using the phone number 3800971234567 made by the customer customer1 in the project 2664.

Figure: Example of data in a successful purchase callback

{
        "project_id": 2664,
        "payment": {
            "id": "S0332_20200710_133159_73006807",
            "type": "purchase",
            "status": "success",
            "date": "2020-07-10T10:32:32+0000",
            "method": "mobile",
            "sum": {
                "amount": 33200,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800971234567"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 711,
            "type": "sale",
            "status": "success",
            "date": "2020-07-10T10:32:32+0000",
            "created_date": "2020-07-10T10:31:59+0000",
            "request_id": "eaccec8fcdefa3c6e3825e...2d646369c1-00000001",
            "sum_initial": {
                "amount": 33200,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 33200,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2223,
                "payment_id": "15943771212",
                "auth_code": ""
            }
        },
        "signature": "py7aBmHSdibbtc6ALYnPcQV7zkY...GQWeRRwlOMtKI6m+81aWvpEwQ=="
    }

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

Figure: Example of data in a declined purchase callback

{
        "project_id": 2664,
        "payment": {
            "id": "D0320_20200710_134338_67886731",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-10T10:43:51+0000",
            "method": "mobile",
            "sum": {
                "amount": 32000,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800971234567"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 764,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-10T10:43:51+0000",
            "created_date": "2020-07-10T10:43:38+0000",
            "request_id": "18bc2e7b37883c787d37...f5854ec75a4e1eff41874-00000001",
            "sum_initial": {
                "amount": 32000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 32000,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2223,
                "payment_id": "15943778211",
                "auth_code": ""
            }
        },
        "signature": "2T6qRAdB2zPtWqLqmgvzNso1h...VUc1SIM419KlEIFSoQ=="
    }

Related topics

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

Payouts by using Gate

General information

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



Figure: Payout by using Gate

  1. A customer orders a payout through the Mobile Commerce in Ukraine system.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the Mobile Commerce in Ukraine service.
  7. The payout is processed on the Mobile Commerce in Ukraine side.
  8. Mobile Commerce in Ukraine sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

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

Request format

There are several things you must consider when using payout requests in the Mobile Commerce in Ukraine method:
  1. You send payout requests by sending the /v2/payment/mobile/payout request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
    • Object customer—customer information:
      • id—identifier on the web service side
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer mobile number for payout, for example 3800501234567 (the number must be specified with the country code and without the + sign)
      • service_provider—identifier of the network operator
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Mobile Commerce in Ukraine method must include project and payment IDs, the currency code and the amount of a payment, customer and account information, as well as the signature as shown in the following example:

Figure: Example of a payout request

{
    "general": {
        "project_id": 35,
        "payment_id": "payout_65",
        "signature": "akchavu5w7v8vwg467Zie3x/wG8JuRey87Q4Oyb3FzF+2uWs1"
    },
    "customer": {
        "id": "user45",
        "ip_address": "66.249.79.102"
    },
    "account": {
        "number": "3800501234567",
        "service_provider": "VODAFONE"
    },
    "payment": {
        "amount": 1000,
        "currency": "UAH"
    }
}

Callback format

The Mobile Commerce in Ukraine method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 101.00 UAH payout to account 3800501234567 made to the customer1 customer in the 2664 project.

Figure: Example of data in a successful payout callback

{
        "project_id": 2664,
        "payment": {
            "id": "S0101_20200710_140630_66147689",
            "type": "payout",
            "status": "success",
            "date": "2020-07-10T11:06:35+0000",
            "method": "mobile",
            "sum": {
                "amount": 10100,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800501234567",
            "type": "VODAFONE"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 818,
            "type": "payout",
            "status": "success",
            "date": "2020-07-10T11:06:35+0000",
            "created_date": "2020-07-10T11:06:30+0000",
            "request_id": "c48b2cad0ff3775bc32717af...d0a2cac7d95cdfa2f-00000001",
            "sum_initial": {
                "amount": 10100,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 10100,
                "currency": "UAH"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2223,
                "payment_id": "15943791930",
                "auth_code": ""
            }
        },
        "signature": "7dXKXo0GyDcLQ8Et5t...r3xn+xL5RcpqjaxRi4pJlWA=="
    }

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

Figure: Example of data in a declined payout callback

{
        "project_id": 2664,
        "payment": {
            "id": "D0246_20200710_141726_61240779",
            "type": "payout",
            "status": "decline",
            "date": "2020-07-10T11:17:37+0000",
            "method": "mobile",
            "sum": {
                "amount": 24600,
                "currency": "UAH"
            },
            "description": "test"
        },
        "account": {
            "number": "3800501234567",
            "type": "VODAFONE"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 847,
            "type": "payout",
            "status": "decline",
            "date": "2020-07-10T11:17:37+0000",
            "created_date": "2020-07-10T11:17:28+0000",
            "request_id": "19bbb72fa221998695b9858d2c6...5f3a538f7527a9-00000001",
            "sum_initial": {
                "amount": 24600,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 24600,
                "currency": "UAH"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2223,
                "payment_id": "15943798538",
                "auth_code": ""
            }
        },
        "signature": "VMSdQC3zswwE4Vn2aqLG...DSFL41y1SbpwLTLFBg=="
    }

Related topics

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

Payouts by using Dashboard (Old Dashboard)

To make a payout through Dashboard (Old Dashboard), the merchant sends a request, and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard (Old Dashboard):
  • as a single payout—in this case, you must specify the currency and amount for a payout available for this method, and fill in all fields required on the Dashboard (Old Dashboard) interface in accordance with the selected payment method
  • as a part of a mass payment—in this case, all parameters are specified in a CSV file in accordance with the requirements in the Payouts by using Gate section (except for the signature)

Information about performed payouts is displayed in the Payments section of Dashboard (Old Dashboard).

More detailed information on the payout processing by using Dashboard (Old Dashboard) is provided in the Bulk payments section.

Analysis of payments results

As with other payment methods ECommPay offers, when using the Mobile Commerce in Ukraine 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, for instance you can use the analytic panels on the Analytics tab to this end.

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 and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • 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 using the /operations/get queries.

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