Card payments via partner (Ukraine)

Overview

Payment method that supports purchase and payout processing via partners in Ukraine 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 UA
Payment currencies UAH
Currency conversion +
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to your key account manager ECommPay

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, UAH
Payment Page CMS Plug-ins Gate Dashboard minimum maximum
Purchases + + 1.00 30,000.00
Payouts + 1.00

Processing scenarios

To perform a purchase operation, you need to redirect customer to the partner's service, 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

To perform 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 website.
  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 UAH.
  3. If you need to have payment form displayed with the method selected, set the force_payment_method parameter to card_visa for Visa cards or card_mc for Mastercard and Maestro cards.
  4. If required, you can also add any other additional parameters Payment Page supports.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request for purchase must include project, customer and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'RUB',
      customer_id: '123', 
      project_id: 0, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/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.

The following is the example of a callback with an information about successful 300.00 UAH purchase from card 473118******4111 made by the ALEX customer in the 159 project.

Figure: Example of a successful purchase callback

{
        "project_id": 159,
        "payment": {
            "id": "4287815",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "method": "card-visa",
            "sum": {
                "amount": 30000,
                "currency": "UAH"
            },
            "description": "deposit"
        },
        "account": {
            "number": "473118******4111"
        },
        "customer": {
            "id": "ALEX"
        },
        "operation": {
            "id": 43597000001900,
            "type": "sale",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "created_date": "2019-09-02T14:32:38+0000",
            "request_id": "f1a89d3dc77",
            "sum_initial": {
                "amount": 30000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": "162534485",
                "date": "2019-09-02T17:34:11+0000",
                "auth_code": "",
                "endpoint_id": "107001"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "T+x5ZXCbHhK36FB+B1ASRJO+LfRrgLjonhPlp6aBN...=="
    }

The following is the example of a callback for a purchase declined due to inappropriate payment amount.

Figure: Example of a declined purchase callback

 {
        "payment": {
            "date": "2019-08-30T05:19:43+0000",
            "id": "TEST_1566576319342",
            "method": "card-visa",
            "status": "decline",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "type": "purchase",
            "description": "ECT_TEST_1566576319342"
        },
        "project_id": 408,
        "errors": [
            {
                "code": "2642",
                "message": "Limit Overrun Code",
                "description": "fatal: LIMIT_OVERRUN_CODE"
            }
        ],
        "operation": {
            "id": 40092000001666,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-30T05:19:43+0000",
            "created_date": "2019-08-30T05:19:42+0000",
            "request_id": "d00b9813846f7383",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 38,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "tFmruTrvie1nuR+2GZmnFi1e+ngVczvjO1YJM3Gehi...=="
    }

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 service.
  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 service.
  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/interkassa20/card-visa/salefor Visa cards or /v2/payment/interkassa20/card-mc/sale for Mastercard and Maestro cards request by using HTTP method POST. This is a request group of /v2/payment/interkassa20/{payment_method}/sale,
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase identifier
    • 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
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. The currency of purchase can only be UAH.
  4. If required, you can also add any other additional parameters Gate supports.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

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

Figure: Example of a purchase request

{ 
   "general": { 
      "project_id": 159,
      "payment_id": "561719496",
      "signature": "fCkXYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4Bm...=="
   },
   "customer": { 
      "id": "ALEX",
      "ip_address": "1.2.3.4"
   },
   "payment": { 
      "amount": 3000,
      "currency": "UAH"
   }
}

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 HTML page using the method specified in the redirect_data.method parameter.

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

  "redirect_data": {
                    "body": {
                        "ik_am": "300.00",
                        "ik_co_id": "3c1eaf9b398",
                        "ik_cur": "UAH",
                        "ik_desc": "deposit",
                        "ik_pm_no": "43597000001900",
                        "ik_pw_via": "visa_uah",
                        "ik_suc_u": "https://example.com/process/complete-redirect?wsid=m2l22f5",
                        "ik_suc_m": "POST",
                        "ik_fal_u": "https://example.com/process/complete-redirect?wsid=m2l22f5",
                        "ik_fal_m": "POST",
                        "ik_ltm": "2578400"
                    },
                    "method": "GET",
                    "url": "https://pay.site.com/api/v1/checkout/16ebbf79/form"
                }

Callback format

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

The following is the example of a callback with an information about successful 300.00 UAH purchase from card 473118******4111 made by the ALEX customer in the 159 project.

Figure: Example of a successful purchase callback

{
        "project_id": 159,
        "payment": {
            "id": "4287815",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "method": "card-visa",
            "sum": {
                "amount": 30000,
                "currency": "UAH"
            },
            "description": "deposit"
        },
        "account": {
            "number": "473118******4111"
        },
        "customer": {
            "id": "ALEX"
        },
        "operation": {
            "id": 43597000001900,
            "type": "sale",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "created_date": "2019-09-02T14:32:38+0000",
            "request_id": "f1a89d3dc77",
            "sum_initial": {
                "amount": 30000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": "162534485",
                "date": "2019-09-02T17:34:11+0000",
                "auth_code": "",
                "endpoint_id": "107001"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "T+x5ZXCbHhK36FB+B1ASRJO+LfRrgLjonhPlp6aBN...=="
    }

The following is the example of a callback for a purchase declined due to inappropriate payment amount.

Figure: Example of a declined purchase callback

 {
        "payment": {
            "date": "2019-08-30T05:19:43+0000",
            "id": "TEST_1566576319342",
            "method": "card-visa",
            "status": "decline",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "type": "purchase",
            "description": "ECT_TEST_1566576319342"
        },
        "project_id": 408,
        "errors": [
            {
                "code": "2642",
                "message": "Limit Overrun Code",
                "description": "fatal: LIMIT_OVERRUN_CODE"
            }
        ],
        "operation": {
            "id": 40092000001666,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-30T05:19:43+0000",
            "created_date": "2019-08-30T05:19:42+0000",
            "request_id": "d00b9813846f7383",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 38,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "tFmruTrvie1nuR+2GZmnFi1e+ngVczvjO1YJM3Gehi...=="
    }

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.

Information on the format of requests and parameters for initiating payouts by using Gate, as well as on the format of callbacks with the payout results is given in the Payout section; for general information on working with the API, see the section API Description.

The currency of payout by using partner service can only be UAH.

Related topics

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

Testing

General information

For the payment method the testing of purchases by using Payment Page and Gate.

Testing can be performed within a test project, to enable and disable the testing availability, contact ECommPay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the currency can be only UAH, and the interfaces of the payment forms emulator of Payment Page and partner differ from the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

  • decline status with 40000 or 40400 amount
  • success status with any other amount

Purchases by using Payment Page

To perform a test purchase by using Payment Page, do the following:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the card_visa or card-mc method was not specified in the request—select the method on the emulator page.
  3. Click the Success or Decline button (depending on the amount specified in the request).
  4. Accept a callback with information about the payment result.

The full information about purchase process by using Payment Page is provided in the section Purchases by using Payment Page.

Purchases by using Gate

To perform a test purchase by using Gate, do the following:

  1. Send a correct test request for purchase to the payment platform.
  2. Accept a callback with redirection data.
  3. Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
  4. Accept a callback with information about the payment result.

The full information about purchase process by using Gate is provided in the section Purchases by using 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.