Card payments via partner (Uzbekistan)

Overview

Payment method that supports purchase and payout processing via partner by using payment cards. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

Download the logo in vector format here.
Payment method type Card payments via partner
Countries and regions Uzbekistan
Payment currencies UZS
Currency conversion
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to the Monetix key account manager

Interaction diagram

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

Operations support

Interfaces Amounts, USD * Times
Payment Page Gate Dashboard minimum maximum basic threshold
Purchases
Payouts within 20 minutes up to 24 hours

* The amount limits of payments specify with the 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

To perform a purchase operation, you need to redirect customer to the partner's Telegram bot, while to perform a payout, you need to notify customer via merchant's web service.

Figure 1. Purchase by using Payment Page
Figure 2. Purchase by using Gate
Figure 3. Payout 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.

Purchase by using Payment Page

General information

In the 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 Monetix 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 4. Purchase sequence in the Payment Page method:
  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 Monetix 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 Monetix 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 payment method.
  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's Telegram bot.
  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 required for any payment method:
    • project_id—project ID you obtained from Monetix
    • payment_id—payment ID unique within the project
    • customer_id—the unique ID of the customer within your project
    • customer_email—customer email
    • customer_first_name—customer first name
    • customer_last_name—customer last name
    • payment_currency—payment currency 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.
  2. The currency of payment can only be UZS.
  3. To avoid errors in redirection to the partner's service is recommended to use the payment_extra_param parameter and set its value to uzcard.
  4. If you need to have payment form displayed with the method selected, set the force_payment_method parameter to card-partner.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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 request for Payment Page opening:

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: 10000, 
        payment_extra_param: 'uzcard',   
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

Callback format

The standard format for callbacks is used to deliver purchase results. For more information, see Callbacks in Payment Page.

Unlike other payment methods, in case of a successful purchase the callbacks contain the customer card identifier used by the partner in the number parameter of the account object. The masked number of the card is contained in the masked_card parameter in the provider_extra_fields object. When a customer uses different cards the mentioned parameters have different values. It should also be taken into account that the card identifiers can be used for payout processing (specified in the number parameter of the account object).

The following is the example of a callback with an information about successful 1,000.00 UZS purchase made by the customer in the 579 project.

Figure 5. Example of a successful purchase callback
{
        "project_id": 579,
        "payment": {
            "id": "307657677656546777",
            "type": "purchase",
            "status": "success",
            "date": "2019-10-08T14:13:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100000,
                "currency": "UZS"
            },
            "description": ""
        },
        "customer": {
            "id": "65465"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F543"
        },
        "provider_extra_fields": {
            "masked_card": "411111******1111"
        },
        "operation": {
            "id": 9708000007271,
            "type": "sale",
            "status": "success",
            "date": "2019-10-08T14:13:50+0000",
            "created_date": "2019-10-08T14:02:18+0000",
            "request_id": "30d9d5d9d7966a8a74b44ba559b1a989f2cad321e2-00009709",
            "sum_initial": {
                "amount": 100000,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "UZS"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1521,
                "payment_id": "632441",
                "auth_code": "",
                "date": "2019-10-08T14:02:19+0000"
            }
        },
        "signature": "gh13skxTd+KkEUemF3KaFYyLCTiteYp5FhTJJWu+qdhbMYUyLSf/uICQ
                                            BC9enst71izQvQ670YIpSkL1nyO90WA=="
    }
}

The following is the example of a callback for a purchase declined due to insufficient funds on customer account.

Figure 6. Example of a declined purchase callback
{
        "project_id": 579,
        "payment": {
            "id": "307657677656546777",
            "type": "purchase",
            "status": "decline",
            "date": "2019-10-08T14:13:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100000,
                "currency": "UZS"
            },
            "description": ""
        },
        "customer": {
            "id": "65465"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F543"
        },
        "provider_extra_fields": {
            "masked_card": "411111******1111"
        },
        "operation": {
            "id": 9708000007271,
            "type": "sale",
            "status": "decline",
            "date": "2019-10-08T14:13:50+0000",
            "created_date": "2019-10-08T14:02:18+0000",
            "request_id": "30d9d5d9d7966a8a74b44ba559b1a989f2cad321e2-00009709",
            "sum_initial": {
                "amount": 100000,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "UZS"
            },
            "code": "20105",
            "message": "Insufficient funds on customer account",
            "provider": {
                "id": 1521,
                "payment_id": "632441",
                "auth_code": "",
                "date": "2019-10-08T14:02:19+0000"
            }
        },
        "signature": "gh13skxTd+KkEUemF3KaFYyLCTiteYp5FhTJJWu+qdhbMYUyLSf/uICQ
                                            BC9enst71izQvQ670YIpSkL1nyO90WA=="
    }
}

Related topics

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

Purchase by using Gate

General information

In the 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. Perform the redirection of a customer to the partner's Telegram bot.
  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 7. Purchase by using Gate
  1. A customer initiates a purchase through partner on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified Monetix 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 structure.
  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' Telegram bot.
  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 from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the 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-partner/sale request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—the project ID you obtained from Monetix
      • 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.
    • customer—object with customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address of the customer's device
      • email—customer email
      • first_name—customer first name
      • last_name—customer last name
    • payment—object with purchase information:
      • 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—code of purchase currency in the ISO-4217 alpha-3 format
      • extra_param—additional parameter. Set it to the uzcard value
  3. The currency of purchase can only be UZS.
  4. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
    • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
      • success—the URL to redirect the customer to after the payment is successfully completed
      • decline—the URL to redirect the customer to after the payment is declined
      • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request
  5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the partner method.

Figure 8. Example of 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": 10000,
        "currency": "UZS",
        "extra_param": "uzcard"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the partner service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

  • url—the URL to redirect the customer to
  • body—the data to be sent in the request body
  • method—the HTTP method to get an HTML page of the website (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

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

Callback format

The standard format for callbacks is used to deliver purchase results. For more information, see Callbacks in Gate.

Unlike other payment methods, in case of a successful purchase the callbacks contain the customer card identifier used by the partner in the number parameter of the account object. The masked number of the card is contained in the masked_card parameter in the provider_extra_fields object. When a customer uses different cards the mentioned parameters have different values. It should also be taken into account that the card identifiers can be used for payout processing (specified in the number parameter of the account object).

The following is the example of a callback with an information about successful 1,000.00 UZS purchase made by the customer in the 579 project.

Figure 9. Example of a successful purchase callback
{
        "project_id": 579,
        "payment": {
            "id": "307657677656546777",
            "type": "purchase",
            "status": "success",
            "date": "2019-10-08T14:13:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100000,
                "currency": "UZS"
            },
            "description": ""
        },
        "customer": {
            "id": "65465"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F543"
        },
        "provider_extra_fields": {
            "masked_card": "411111******1111"
        },
        "operation": {
            "id": 9708000007271,
            "type": "sale",
            "status": "success",
            "date": "2019-10-08T14:13:50+0000",
            "created_date": "2019-10-08T14:02:18+0000",
            "request_id": "30d9d5d9d7966a8a74b44ba559b1a989f2cad321e2-00009709",
            "sum_initial": {
                "amount": 100000,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "UZS"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1521,
                "payment_id": "632441",
                "auth_code": "",
                "date": "2019-10-08T14:02:19+0000"
            }
        },
        "signature": "gh13skxTd+KkEUemF3KaFYyLCTiteYp5FhTJJWu+qdhbMYUyLSf/uICQ
                                            BC9enst71izQvQ670YIpSkL1nyO90WA=="
    }
}

The following is the example of a callback for a purchase declined due to insufficient funds on customer account.

Figure 10. Example of a declined purchase callback
{
        "project_id": 579,
        "payment": {
            "id": "307657677656546777",
            "type": "purchase",
            "status": "decline",
            "date": "2019-10-08T14:13:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 100000,
                "currency": "UZS"
            },
            "description": ""
        },
        "customer": {
            "id": "65465"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F543"
        },
        "provider_extra_fields": {
            "masked_card": "411111******1111"
        },
        "operation": {
            "id": 9708000007271,
            "type": "sale",
            "status": "decline",
            "date": "2019-10-08T14:13:50+0000",
            "created_date": "2019-10-08T14:02:18+0000",
            "request_id": "30d9d5d9d7966a8a74b44ba559b1a989f2cad321e2-00009709",
            "sum_initial": {
                "amount": 100000,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "UZS"
            },
            "code": "20105",
            "message": "Insufficient funds on customer account",
            "provider": {
                "id": 1521,
                "payment_id": "632441",
                "auth_code": "",
                "date": "2019-10-08T14:02:19+0000"
            }
        },
        "signature": "gh13skxTd+KkEUemF3KaFYyLCTiteYp5FhTJJWu+qdhbMYUyLSf/uICQ
                                            BC9enst71izQvQ670YIpSkL1nyO90WA=="
    }
}

Related topics

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

Payout by using Gate

General information

To perform a payout through the partner 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.

Figure 11. Payout by using Gate
  1. A customer orders a payout through the merchant web service.
  2. Merchant web service sends the request for the payout processing by using Gate to the appropriate Monetix URL.
  3. Gate redirects the request to the Monetix 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 structure.
  6. The payment platform redirects the payout request to the partner service.
  7. The payout is processed on the partner side.
  8. Partner 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.

Request format

There are several things you must consider when using payout requests in the method:

  1. You send payout requests by sending the /v2/payment/card-partner/payout request 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 created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • customer—object with customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address of the customer's device
      • email—customer email
      • first_name—customer first name
      • last_name—customer last name
    • 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 have 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
    • account—object with customer payment card information:
      • number—card identifier which is used by the partner service for payout processing; the value of this parameter can be one of the identifiers received from the partner in callbacks with information about purchases made by customer specified in the customer.id parameter
  3. The currency of payout can only be UZS.
  4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request in the partner method.

Figure 12. Example of data from a payout 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"
    },
    "account":{
        "number": "1743-3223966A2D...514183B2584F543"
    },
    "payment": {
        "amount": 10000,
        "currency": "UZS"
    }
}

Callback format

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

Note that unlike other payment methods, in this method, the callbacks contain customer card identifier (which is used by the provider for payment processing) in the number parameter of the account object.

The following is the example of a callback with an information about successful 5.00 UZS payout made in the 112 project.

Figure 13. Example of a successful payout callback
{
        "project_id": 112,
        "payment": {
            "id": "ORDER_ID_123",
            "type": "payout",
            "status": "success",
            "date": "2020-01-29T11:43:00+0000",
            "method": "Card partner",
            "sum": {
                "amount": 500,
                "currency": "UZS"
            },
            "description": "Test payout"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F543"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 2000000026,
            "type": "payout",
            "status": "success",
            "date": "2020-01-29T11:43:00+0000",
            "created_date": "2020-01-29T11:42:54+0000",
            "request_id": "1b47b55b41cf0cdd02b82a02bac2ba-00000003",
            "sum_initial": {
                "amount": 500,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "UZS"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1743,
                "payment_id": "1580298177082",
                "auth_code": "",
                "date": "2019-08-28T07:14:54+0000"
            }
        },
        "signature": "PsjbijucMMiDh50NSgareVvte+/NN/6cgqwV745Qt2j15yqBLWoRQ=="
    }
}

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

Figure 14. Example of a declined payout callback
{
        "project_id": 112,
        "payment": {
            "id": "ORDER_ID_123",
            "type": "payout",
            "status": "decline",
            "date": "2020-01-29T11:44:00+0000",
            "method": "Card partner",
            "sum": {
                "amount": 500,
                "currency": "UZS"
            },
            "description": "Test payout"
        },
        "account": {
            "number": "1743-3223966A2D...514183B2584F544"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 2000000026,
            "type": "payout",
            "status": "success",
            "date": "2020-01-29T11:43:00+0000",
            "created_date": "2020-01-29T11:42:54+0000",
            "request_id": "1b47b55b41cf0cdd02b82a02bac2ba-00000003",
            "sum_initial": {
                "amount": 500,
                "currency": "UZS"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "UZS"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1743,
                "payment_id": "1580298177082",
                "auth_code": "",
                "date": "2019-08-28T07:14:54+0000"
            }
        },
        "signature": "PsjbijucMMiDh50NSgareVvte+/NN/6cgqwV745Qt2j15yqBLWoRQ=="
    }
}

Related topics

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

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • 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.

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.