Mobile Commerce in Ukraine

Interaction diagram

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

Operations support

	Interfaces			Amounts, UAH		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				*	*	*	*
Payouts				*	*	*	*

* For more information, 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

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.

In the course of purchase processing, a short message with payment confirmation code is sent to the customer from the provider service side. Due to specifics of provider service operation, to confirm the purchase, the customer can enter the confirmation code on Payment Page (for purchases by using Payment Page) or on the side of the web service (for purchases by using Gate), or send a reply short message to the received message.

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.

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

General information

In the 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 Monetix 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 methods. The full sequence and particularities of the purchase process are provided below.

In the course of purchase processing, a short message with payment confirmation code is sent to the customer from the provider service side. To confirm the payment, the customer can either specify the confirmation code on Payment Page or send a reply short message to the received message. In the former case, the process of confirmation involves the use of the Monetix payment platform. In the latter case, the information about payment confirmation is forwarded directly to the provider service, and the Monetix payment platform is not involved in the payment confirmation process.

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 Monetix
   • 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 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.
   • customer_id—the ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
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 punctuation or special characters, 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.

Here is an example of data from a purchase request.

    { 
      project_id: 12,
      payment_id: 'X03936', 
      payment_currency: 'UAH', 
      payment_amount: 1000, 
      customer_id: '123',
      customer_first_name: 'John', 
      customer_last_name: 'Doe',
      customer_email: 'johndoe@example.com',
      customer_phone: '3800971234567',
      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 in Payment Page.

The callback with information about payment result can be sent to the web service even when the payment is confirmed via the reply short message with Monetix not involved in the payment confirmation process.

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.

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

{
        "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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 Monetix URL.
2. Receive the additional payment information callback and send the request with the required data to continue the payment. For more details, see Submission of additional payment information.
3. Get the callback with the payment result from the payment platform.

In the course of purchase processing, a short message with payment confirmation code is sent to the customer from the provider service side. To confirm the payment, the customer can either specify the confirmation code on the side of the web service or send a reply short message to the received message. In the former case, confirmation procedure involves the use of the Monetix payment platform. In the latter case, the information about payment confirmation is forwarded directly to the provider service, and the Monetix payment platform is not involved in the payment confirmation process.

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 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:
   • general—object with general request information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • payment—object with payment details:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—purchase currency code in the ISO-4217 alpha-3 format
   • customer—object with customer information:
     • id—customer identifier on the web service side
     • ip_address—customer device IP
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with 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 punctuation or special characters)
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.

Here is an example of data from a purchase request.

{
  "general": {
    "project_id": 382,
    "payment_id": "e16d0d998485698c652f96f6b2ff8826",
    "signature": "3zjYFqRhDsaTLF7FVv4yu+Zie3x/...wG8JuRey87Q4Oyb3FzF+2uWs1Ka"
  },
  "customer": {
    "id": "123",
    "ip_address": "66.249.79.102",
     "first_name": "John",
     "last_name": "Doe",
     "email": "johndoe@email.com"
  },
  "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 in Gate.

The callback with information about payment result can be sent to the web service even when the payment is confirmed via the reply short message with Monetix not involved in the payment confirmation process.

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.

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

{
        "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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 Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

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

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:
   • general—object with 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
   • payment—object with payout information:
     • amount—payout 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—payout currency in the ISO-4217 alpha-3 format.
   • customer—object with customer information:
     • id—identifier on the web service side
     • ip_address—customer device IP
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with customer account information:
     • number—customer mobile number for payout, for example 3800501234567 (the number must be specified with the country code and without punctuation or special characters)
     • service_provider—identifier of the network operator
3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request.

{
    "general": {
        "project_id": 35,
        "payment_id": "payout_65",
        "signature": "akchavu5w7v8vwg467Zie3x/wG8JuRey87Q4Oyb3FzF+2uWs1"
    },
    "customer": {
        "id": "user45",
        "ip_address": "66.249.79.102",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@email.com"
    },
    "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 in Gate.

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.

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

{
        "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

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.