PayMe mobile

Overview

PayMe mobile, a popular payment method in Uzbekistan, offers your customers a convenient way of paying for your services. In the PayMe mobile payment method, customers make purchases by using bank transfers.

With PayMe mobile, you can accept payments from your customers by using Payment Page and Gate.

Download the logo in the vector format here.
Payment method type Bank transfers
Countries and regions Uzbekistan
Payment currencies UZS
Currency conversion On the Monetix side
Purchases
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations
  • If the customer transfers an amount which is different from the amount specified in the purchase request, the payment processing will proceed as described in Handling payments with amount changed by customer.
  • The payment details expiration time is shown in the payment instructions. If the customer fails to complete the payment within given time, the payment will be declined. To change the payment expiration time, contact the Monetix technical support (support@monetix.pro).
Onboarding and access fee Contact your key account manager at Monetix for details.

Operations support

Interfaces Payment amount, UZS Payment processing time
Payment Page Gate Dashboard minimum maximum basic threshold
Purchase 30,000.00 10,000,000.00 5 minutes 24 hours

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.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the PayMe mobile payment method:

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

The following figure shows the complete purchase processing flow in the PayMe mobile payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The Monetix payment platform receives the request.
  4. The payment platform processes the request and checks whether it contains all the required parameters and the signature is correct.
  5. The payment platform creates the checkout page based on the project settings and request parameters.
  6. The checkout page is displayed to the customer.
  7. The customer chooses to make a purchase with the PayMe mobile payment method.
  8. Payment Page forwards the purchase request to the payment platform.
  9. The payment platform processes the request and forwards it to the provider service.
  10. The provider service processes the purchase request.
  11. The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
  12. The payment platform forwards the instructions to Payment Page.
  13. Payment Page displays the payment instructions to the customer.
  14. The customer completes the purchase.
  15. The provider service processes the purchase.
  16. The provider service sends the purchase result information to the payment platform.
  17. The payment platform sends a callback with the payment result to your system.
  18. The payment platform sends the payment result to Payment Page.
  19. Payment Page 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 Payment Page with the PayMe mobile payment method.

Table 1. Basic parameters of requests to Payment Page

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

project_id
integer
strictly required

 Project ID you obtained from Monetix when integrating.

Example: 123

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

payment_currency
string
strictly required

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

Example: UZS

payment_amount
integer
strictly required

 Purchase 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: 200,000.00 UZS must be sent as 20000000

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.

force_payment_method
string
optional

 Parameter that allows you to enforce the PayMe mobile payment method for your customer and skip the page with payment method selections.

To enforce the PayMe mobile payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to sbp-p2p. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'sbp-p2p'
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',
        payment_currency: 'UZS',
        payment_amount: 20000000,
        force_payment_method: 'sbp-p2p',    
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback

In the PayMe mobile 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": "2022-03-25T11:08:45+0000",
        "method": "SBP P2P transfer",
        "sum": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "sum_converted": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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": "2022-03-25T11:20:30+0000",
        "method": "SBP P2P transfer",
        "sum": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "sum_converted": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

Purchase by using Gate

General information

To perform a purchase by using Gate with the PayMe mobile payment method:

  1. Send the request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with the payment instructions to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the PayMe mobile payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to Gate.
  3. The Monetix payment platform receives the request.
  4. The payment platform checks whether the request contains all the required parameters and correct signature.
  5. 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.)
  6. The payment platform processes the request and forwards it to the provider service.
  7. The provider service processes the purchase request.
  8. The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
  9. The payment platform forwards the instructions to your system in the display_data object.
  10. Your system displays the payment instructions to the customer.
  11. The customer completes the purchase.
  12. The provider service processes the purchase.
  13. The provider service informs the payment platform about the purchase result.
  14. The payment platform sends the callback with the payment result to your system.
  15. 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 PayMe mobile payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/sbp-p2p/sale
Full API endpoint specification /v2/payment/sbp-p2p/sale
Table 2. Basic parameters of a purchase request

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: 123

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

email
string
strictly required

 Customer's email.

Example: johndoe@example.com

first_name
string
strictly required

 Customer's first name.

Example: John

last_name
string
strictly required

 Customer's last name.

Example: Doe

payment
object
strictly required

amount
integer
strictly required

 Purchase 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: 200,000.00 UZS must be sent as 20000000

currency
string
strictly required

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

Example: UZS
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 PayMe mobile payment method.

Figure 5. Example of the data from a purchase request
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 20000000,
        "currency": "UZS"
    }
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer. Each element of this array contains the following parameters:

  • type—element type. its value is always add_info.
  • title—name of the payment instruction data, can take one the following values:
    • amount—purchase amount in minor currency units
    • currency—purchase currency code in ISO-4217 alpha-3 format
    • receiver_name—full name of the payment recipient
    • receiver_account—phone number of the payment recipient
    • lifetime—payment details expiration time in seconds
    • bank_name—name of the payment recipient's bank
  • data—payment instruction data

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "amount",
        "data": "4100000"
    },
    {
        "type": "add_info",
        "title": "currency",
        "data": "UZS"
    },
    {
        "type": "add_info",
        "title": "receiver_name",
        "data": "John Doe"
    },
    {
        "type": "add_info",
        "title": "receiver_account",
        "data": "998932145678"
    },
    {
        "type": "add_info",
        "title": "lifetime",
        "data": 600
    },
    {
        "type": "add_info",
        "title": "bank_name",
        "data": "Example Bank"
    }
]

Callback

In the PayMe mobile payment method, the payment platform returns the purchase 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 purchase.

Figure 6. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "SBP P2P transfer",
        "sum": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "sum_converted": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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": "2022-03-25T11:20:30+0000",
        "method": "SBP P2P transfer",
        "sum": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "sum_converted": {
            "amount": 20000000,
            "currency": "UZS"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

Analysis of payments results

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.