Kassa24 Terminal

Operations support

	Interfaces			Payment amount, KZT		Payment processing time
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				1.00	500,000.00	1 minute	36 days

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

In the Kassa24 Terminal method to perform a purchase operation customer needs to pay by cash in terminal.

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.

General information

In the Kassa24 Terminal method, when processing a purchase by using Gate, the merchant web service is required to do the following:

1. Process the request for checking customer account existence.
2. Send information about customer account existence.
3. Process request for receiving payment ID on the web service side.
4. Send payment ID.
5. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Kassa24 Terminal 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 always verify
   • customer_id—customer identifier on the web service side
   • project_id—the project ID obtained from Monetix
   • signature—signature created after you specify all the required parameters

 {
    "type": "verify",   
    "customer_id": "7123456789",
    "project_id": 1234,
    "signature": "e19695449545fac562843ca06e7e0f3e51281ad6"
}

Request check_deposit for payment ID

There are several things you must consider when using requests for payment ID on the web service side:

1. The check_deposit request for payment ID is sent out 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, set to check_deposit at all times
   • customer_id—customer ID on the web service side
   • project_id—the project ID obtained from Monetix
   • 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—currency in the ISO-4217 alpha-3 format
   • payment_method—payment method name, set to kassa24 at all times
   • signature—signature created after you specify all the required parameters (for more information about signature generation, see Signature generation and verification)

   {
      "type": "check_deposit",
      "project_id": 1234,
      "customer_id": "johndoe@example.com",
      "amount": 10000,
      "currency": "KZT",
      "payment_method": "kassa24",
      "signature": "lY0LTSAzpR7...dOqRXJnL1kO0lUmkQ0YYLWRg=="
   }

Request format

Upon receiving a request from the Monetix platform, your system must send out a synchronous response with one of the response codes provided below.

Response to the verify request

In case of a successful result of the verify request, the response should contain a response code and payment currency.

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

If it was not possible to find the account, then the response should contain a responce code and an error message.

{ 
   "code": 404,
   "error_description": "Account does not exist"
}

Response to the check_deposit request

• code—response code
• payment_id—payment ID unique on the web service side

A successful response to the request for payment ID must contain response code and unique payment ID within the web service.

{ 
   "code": 0,
   "payment_id": "Asfdsaf3252345",
   "description": "Test payment via terminal"
}

If the requested checking account cannot be found, the response must contain response code and error message.

{ 
   "code": 500,
   "error_description": "Something went wrong"
}

Callback format

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

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

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Kassa24",
        "sum": {
            "amount": 10000,
            "currency": "KZT"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 10000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

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

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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.