Cash-in CIS

Overview

Cash-in CIS is payment method to perform purchases via terminals in the countries from the Commonwealth of Independent States (CIS).

General information

Payment method type Terminal
Countries and regions Depends on the terminal service: KZ, UZ, GE, KG
Payment currencies USD*
Currency conversion On the provider side
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes Cash payment
Onboarding and access fee Refer to your key account manager ECommPay

* The customer can pay using currencies that are allowed in the selected terminal. After currency conversion to USD on the provider side all purchases are processed in the USD currency on the payment platform and web service sides.

Supported terminal services

Name Country
Allpay KZ
BRIO Group UZ
Fenix KZ
Indigo24 KZ
Kassa24 KZ
Money Movers GE
Quickpay KG
Wallet One KZ

Interaction diagram

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

Operations support

  Interfaces Amounts Times***
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + ** **

** For more information refer to your 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

In the Cash-in CIS method to perform a purchase operation customer needs to pay by cash in terminal.

Figure: Purchase by using Gate procedure diagram

Purchase by using Gate

General information

In the Cash-in CIS method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Process request for checking customer account existence.
  2. Send information about customer account existence.
  3. Process request for receiving payment identifier on the web service side.
  4. Send payment identifier.
  5. 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 sequence by using Gate via terminal

  1. Customer selects a web service, the personal account in which he wants to replenish, and then enters his credentials in the merchant system.
  2. The terminal sends request for checking customer account existence to the specified ECommPay URL.
  3. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  4. The payment platform sends request for checking customer account existence to the web service.
  5. The request is processed on the web service side.
  6. The web service sends response to the request.
  7. The payment platform sends customer account data to the Cash-in CIS service.
  8. The Cash-in CIS payment form is displayed to the customer.
  9. The customers pays by cash to replenish personal account.
  10. The payment is processed on the Cash-in CIS side.
  11. The Cash-in CIS service sends the payment result notification to the payment platform.
  12. The payment platform sends request to the web service for payment identifier on the web service side.
  13. The request is processed on the web service side.
  14. The web service sends payment identifier to the payment platform.
  15. Operation is created on the payment platform side.
  16. The payment platform sends the callback to the web service.
  17. The customer receives the payment result on the terminal display.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Cash-in CIS payment method and provide the information on the format of callbacks with purchase results.

Request format

Request verify for checking account existence

  1. The verify request for checking account existence is sent by using HTTP method POST to the specified web service URL.
  2. The request contains the following required parameters:
    • type—operation type on the web service side, value is alwaysverify
    • customer_id—customer identifier on the web service side
    • project_id—the project ID obtained from ECommPay
    • siganture—signature created after you specify all the required parameters

    Figure: Example of a request for checking account existence

    {
       "type":"verify",
       "project_id":111,
       "customer_id":"ovleg@gmail.com",
       "signature":"lY0LTSAz85R7zGce5qfYGacOuYlHGWqkMcQlqmjlsDDZI2gVcE1q
                                  VeWANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
    }

Request check_deposit for payment identifier

  1. The check_deposit request for payment identifier is sent by using HTTP method POST to the specified web service URL.
  2. The request contains the following required parameters:
    • type—operation type on the web service side, value is always verify
    • customer_id—customer identifier on the web service side
    • project_id—the project ID obtained from ECommPay
    • amount—payment amount in minor units
    • currency—currency in the ISO-4217 alpha-3 format
    • payment_method—terminal name. Allowed values:
      • allpay-kz for Allpay
      • briogroup-uz for Brio Group
      • fenix-kz for Fenix
      • indigo24-kz for Indigo24
      • moneymovers-ge for Money Movers
      • quickpay-kg for Quickpay
      • w1-kz for Wallet One
    • signature—signature created after you specify all the required parameters

    Figure: Example of a request for payment identifier

    {
       "type":"check_deposit",
       "project_id":111,
       "customer_id":"ovle8@mail.ru",
       "amount":10000,
       "currency":"USD",
       "payment_method":"briogroup-uz",
       "signature":"lY0LTSAzpR7zGce5qfYGacOuYlHGWqkMcQlqmjlsDDZI2g
                       VcE1qVeWANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
    }

Response format

Response format for the verify request

Response to the verify request must be synchronously sent and contain the following required parameters:

  • code—response code
  • currency—currency in the ISO-4217 alpha-3 format

Figure: Example of the response

{
   "code":0,
   "currency":"USD",
   "additional_customer_id": "HFVDW42345"
}

Response format for the check_deposit request

Response to the check_deposit request must be sent by using HTTP method POST and contain the following required parameters:

  • code—response code
  • payment_id—payment ID unique within the project
Table 1. Allowed response codes
Code Description
0 Successful operation
400 Signature is invalid
404 Account does not exist
500 General error. The reason should be specified in the errors.message parameter

Figure: Example of the response

{
   "code":0,
   "payment_id":"test2345",
   "description":"test payment via terminal"
}

Callback format

The Cash-in CIS method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The method parameter of the payment object contains the name of the terminal service that was used for payment.

The following is the example of a callback with an information about successful 100.01 USD purchase made by customer in the 238 project by using the Brio Group terminal service.

Figure: Example of a successful purchase callback

{
        "project_id": 238,
        "payment": {
            "id": "1556624104",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-30T11:35:06+0000",
            "method": "Brio Group Uz Terminal",
            "sum": {
                "amount": 10001,
                "currency": "USD"
            },
            "description": "test payment"
        },
        "account": {
            "number": "6552"
        },
        "operation": {
            "id": 36011000001676,
            "type": "sale",
            "status": "success",
            "date": "2019-04-30T11:35:06+0000",
            "created_date": "2019-04-30T11:35:05+0000",
            "request_id": "cea199572b36a148f0c20d105b0ee0abf737e06e512e8",
            "sum_initial": {
                "amount": 10001,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10001,
                "currency": "USD"
            },
            "provider": {
                "id": 1217,
                "payment_id": "2019290410",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "jvqLGHIaGdHeF68GtTxAtVFCGzkLxOCFU1crar0RmQpLyDJRoHe
                                   2eGOdPuZKXXKcRJnqEKpNmhLTAtk/VEY8Yw=="
    }

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 Cash-in CIS 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.