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.

General information

Payment method type Card payments via partner
Countries and regions UZ
Payment currencies UZS
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to the ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts, USD * Times **
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum Basic Threshold
Purchases + +
Payouts + within 20 minutes up to 24 hours

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

Processing scenarios

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: Purchase by using Payment Page



Figure: Purchase by using Gate



Figure: Payout by using Gate



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 method, when processing a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the method selected. For more information about preselecting payment methods, see in Preselecting payment method. The full sequence and particularities of the purchase process are provided below.



Figure: 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 ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the 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 mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  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.

Thus, a correct payment request for purchase must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency and signature. It is also recommended to use the payment_extra_param parameter and set its value to uzcard, as shown in the following example of a request:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'UZS', 
      project_id: 198, 
      customer_id: 'test1',
      payment_extra_param: 'uzcard',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vySO\/RLCvhafgqac34gwhq...=="
    }
)

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.

Note that unlike other payment methods, in the case of a successful purchase the callbacks contain customer card identifier (which is used by the provider for payment processing) in the number parameter of the account object. The masked number of the card which was used for purchasing is also contained in the callback in the masked_card parameter of the provider_extra_fields 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: 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: 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:

Purchases 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 ECommPay 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: 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 ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the partner service.
  7. The request is processed on the partner side.
  8. The partner service sends the data for redirecting the customer to the partner service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the partner' 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:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
    • Object payment—purchase information:
      • amount—purchase amount in minor currency units
      • currency—payout 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. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the method must include project, customer and payment IDs, payment and customer data as shown in the following example:

Figure: Example of a purchase request

{ 
   "general": { 
      "project_id": 874,
      "payment_id": "561719496",
      "signature": "fCkXYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4BmNB2sVcrW0r3wcXQggExZHbeXH/VPAMbywQ=="
   },
   "customer": { 
      "id": "customer_test",
      "ip_address": "1.2.3.4"
   },
   "payment": { 
      "amount": 1000,
      "currency": "UZS",
      "extra_param": "uzcard"
   }
}

Formats of the customer redirection data

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

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

"redirect_data": {
        "body": { },
        "method": "GET",
        "url": "https://telegram.me/uzs_tg_bot?start=0891fb3b7cff50a75a212439fe22018c"
    }

Callback format

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

Note that unlike other payment methods, in the case of a successful purchase the callbacks contain customer card identifier (which is used by the provider for payment processing) in the number parameter of the account object. The masked number of the card which was used for purchasing is also contained in the callback in the masked_card parameter of the provider_extra_fields 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: 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: 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:

Payouts 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 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 merchant web service.
  2. Merchant 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 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:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object customer—customer information:
      • id—identifier unique whithin the project
      • ip_address—IP address
    • Object payment—payout information:
      • amount—payout amount in minor currency units
      • currency—payout currency in the ISO-4217 alpha-3 format
    • Object account—customer payment card information:
      • number—card identifier which is used by the provider service for payout processing
  3. The currency of payout can only be UZS.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the method must include project and payment IDs, payment and customer data, card number as shown in the following example:

Figure: Example of a payout request

{ 
   "general": { 
      "project_id": 456,
      "payment_id": "af719496",
      "signature": "kahfYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4BmNB2sVcrW0r3...=="
   },
   "customer": { 
      "id": "customer_test",
      "ip_address": "1.2.3.4"
   },
   "payment": { 
      "amount": 10000,
      "currency": "UZS"
   },
   "account": {
    "number": "1743-3223966A2D...514183B2584F543"
  }
}

Callback format

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

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: 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 sale"
        },
        "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: 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 sale"
        },
        "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:

Analysis of payments results

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

You can load and analyse all the necessary information in Dashboard, 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.