Kassa24

Overview

Kassa24 is a payment method that allows to pay in cash by using Kassa24 kiosks. You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type payment by using kiosks
Countries and regions KZ
Payment currencies KZT
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes payments in cash are performed by customers via Kassa24 kiosks
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

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

Operations support

  Interfaces Amounts, KZT Times**
Payment Page CMS Plugins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + 5.00 * *

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

In the Kassa24 method, to perform a purchase operation customer needs to pay by cash via a kiosk by using the payment instruction.

Figure: Purchase by using Payment Page

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

  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 Kassa24 method.
  8. The phone number input form is displayed to the customer.
  9. The customer enters phone number.
  10. The payment data is displayed to the customer on Payment Page in the form of an instruction. The instruction contains the time within which the payment must be performed by the customer.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Kassa24 side.
  13. The result is displayed to the customer on the Kassa24 website.
  14. The Kassa24 service sends the result notification to the payment platform.
  15. The payment platform sends a callback with the payment result to the web service.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Kassa24 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 Kassa24 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 KZT.
  3. If you need to have payment form displayed with the Kassa24 method selected, set the force_payment_method parameter to kassa24.
  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 in the Kassa24 method 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:

    { payment_id: 'test_payment', 
      payment_amount: 1000, 
      payment_currency: 'KZT',
      customer_id: '123', 
      project_id: 238, 
      signature: "KDHGuawttgeyo+52Kt8KU+Y1Y4HASCQ9OcZzUCwX6R\/ekpZhkIQg=="
    }

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

Callback format

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

The following is the example of a callback with an information about successful 500.00 KZT purchase in the 138 project.

Figure: Example of a successful purchase callback

 { 
        "customer": {
            "id": "eDTptbsRAow="
        },
        "OperationFee": {
            "amount": 0,
            "currency": "KZT"
        },
        "payment": {
            "date": "2019-10-12T15:27:17+0000",
            "id": "11",
            "method": "kassa24",
            "status": "success",
            "sum": {
                "amount": 50000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": ""
        },
        "project_id": 138,
        "phone": "123456789",
        "operation": {
            "id": 8416000007811,
            "type": "sale",
            "status": "success",
            "date": "2019-10-12T15:27:17+0000",
            "created_date": "2019-10-12T15:23:15+0000",
            "request_id": "4f375660191b0d4ef7933284b373041286489-00008417",
            "sum_initial": {
                "amount": 50000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "KZT"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1114,
                "payment_id": "86315380",
                "auth_code": "",
                "date": "2019-10-12T21:26:01+0000"
            }
        },
        "signature": "BJs+ZQ2nCWxumoyEFAISS6jL5rQ0qmnWmCBPAc8BpUDbiWA7Z8+kN9NcpvTgtTA=="

The following is the example of a callback for a purchase declined due to time-out.

Figure: Example of a declined purchase callback

 { 
        "customer": {
            "id": "eDTptbsRdas"
        },
        "OperationFee": {
            "amount": 0,
            "currency": "KZT"
        },
        "payment": {
            "date": "2019-10-12T15:27:17+0000",
            "id": "12",
            "method": "kassa24",
            "status": "decline",
            "sum": {
                "amount": 87900,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": ""
        },
        "project_id": 138,
        "phone": "123456789",
        "operation": {
            "id": 8416000007811,
            "type": "sale",
            "status": "decline",
            "date": "2019-10-12T15:27:17+0000",
            "created_date": "2019-10-12T15:23:15+0000",
            "request_id": "4f375660191b0d4ef7933284b373041286489-00008418",
            "sum_initial": {
                "amount": 87900,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 87900,
                "currency": "KZT"
            },
            "code": "20602",
            "message": "Time-out",
            "provider": {
                "id": 1114,
                "payment_id": "86315380",
                "auth_code": "",
                "date": "2019-10-12T21:26:01+0000"
            }
        },
        "signature": "BJs+ZQ2nCWxumoyEFAISS6jL5rQ0qmnWmCdsadqwDbiWA7Z8+kN9NcpvTgtTA=="

Related topics

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

Purchases by using Gate

General information

In the Kassa24 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. Receive the callback with payment data and display the data to the customer in the form of an instruction.
  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 sequence by using Gate

  1. Customer initiates a purchase through Kassa24 on the merchant web service.
  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 by using 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 Kassa24 service.
  7. The request is processed on the Kassa24 side.
  8. The Kassa24 service sends the payment data to the payment platform.
  9. The payment platform sends the callback with the payment data in the redirect_data object to the web service.
  10. The payment data is displayed to the customer on the web service side in the form of an instruction. The instruction contains the time within which the payment must be performed by the customer.
  11. The customer completes all the required payment steps.
  12. The payment is processed on the Kassa24 side.
  13. The result is displayed to the customer on the Kassa24 side.
  14. The Kassa24 service sends the payment result notification to the payment platform.
  15. The payment platform sends a callback to the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Kassa24 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 when using the Kassa24 method:
  1. You send purchase requests by sending the /v2/payment/cash-in-kz/kassa24/sale request by using the POST HTTP method. This request belongs to the following group: /v2/payment/cash-in-kz/{payment_method}/sale.
  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 units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. It is recommended to specify the phone number of the customer. If the request is missing the parameter, the list of parameters is sent in the clarification callback. For more details, see Additional payment information submission. It is recommended to use the following object and parameter:
    • Object customer—customer information:
      • phone—customer phone number
  4. The currency of purchase can only be KZT.
  5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Kassa24 method must include project, customer and payment IDs, signature, currency and amount of the purchase, IP address and phone number of the customer, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
    "project_id": 138,
    "payment_id": "ID_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+VHq3LAWoXW\/9MTO8yJA=="
  },
  "customer": {
    "id": "123",
    "ip_address": "1.1.1.1",
    "phone": "16132354341"
    },
  "payment": {
    "amount": 1000,
    "currency": "KZT"
  }
}

Callback format

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

The following is the example of a callback with an information about successful 500.00 KZT purchase in the 138 project.

Figure: Example of a successful purchase callback

 { 
        "customer": {
            "id": "eDTptbsRAow="
        },
        "OperationFee": {
            "amount": 0,
            "currency": "KZT"
        },
        "payment": {
            "date": "2019-10-12T15:27:17+0000",
            "id": "11",
            "method": "kassa24",
            "status": "success",
            "sum": {
                "amount": 50000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": ""
        },
        "project_id": 138,
        "phone": "123456789",
        "operation": {
            "id": 8416000007811,
            "type": "sale",
            "status": "success",
            "date": "2019-10-12T15:27:17+0000",
            "created_date": "2019-10-12T15:23:15+0000",
            "request_id": "4f375660191b0d4ef7933284b373041286489-00008417",
            "sum_initial": {
                "amount": 50000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "KZT"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1114,
                "payment_id": "86315380",
                "auth_code": "",
                "date": "2019-10-12T21:26:01+0000"
            }
        },
        "signature": "BJs+ZQ2nCWxumoyEFAISS6jL5rQ0qmnWmCBPAc8BpUDbiWA7Z8+kN9NcpvTgtTA=="
}

The following is the example of a callback for a purchase declined due to time-out.

Figure: Example of a declined purchase callback

 { 
        "customer": {
            "id": "eDTptbsRdas"
        },
        "OperationFee": {
            "amount": 0,
            "currency": "KZT"
        },
        "payment": {
            "date": "2019-10-12T15:27:17+0000",
            "id": "12",
            "method": "kassa24",
            "status": "decline",
            "sum": {
                "amount": 87900,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": ""
        },
        "project_id": 138,
        "phone": "123456789",
        "operation": {
            "id": 8416000007811,
            "type": "sale",
            "status": "decline",
            "date": "2019-10-12T15:27:17+0000",
            "created_date": "2019-10-12T15:23:15+0000",
            "request_id": "4f375660191b0d4ef7933284b373041286489-00008418",
            "sum_initial": {
                "amount": 87900,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 87900,
                "currency": "KZT"
            },
            "code": "20602",
            "message": "Time-out",
            "provider": {
                "id": 1114,
                "payment_id": "86315380",
                "auth_code": "",
                "date": "2019-10-12T21:26:01+0000"
            }
        },
        "signature": "BJs+ZQ2nCWxumoyEFAISS6jL5rQ0qmnWmCdsadqwDbiWA7Z8+kN9NcpvTgtTA=="
}

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 Kassa24 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.