QIWI Kazakhstan

Interaction diagram

Payment processing by using the QIWI Kazakhstan payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as QIWI Kazakhstan service.

Operations support

	Interfaces			Amounts, KZT		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases						*	30 days
Payouts						*	24 hours

* Refer to your key account manager at Monetix for details.

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 QIWI Kazakhstan method, purchases and payouts follow different processing procedures. To perform a purchase operation, you need to redirect customer to the QIWI Kazakhstan service for payment via e-wallet or allow customer to pay via QIWI Kazakhstan kiosk, while to initiate a payout, you need to notify customer via merchant's web service.

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 QIWI Kazakhstan method, 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 Monetix 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 QIWI Kazakhstan method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the QIWI Kazakhstan 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 QIWI Kazakhstan method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment 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.
   • customer_id—the unique ID of the customer within your project
   • customer_email—customer email
   • customer_first_name—customer first name
   • customer_last_name—customer last name
2. The currency of payment can only be KZT.
3. If you need to have payment form displayed with the QIWI Kazakhstan method selected, set the force_payment_method parameter to qiwi-kz.
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.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    { 
        payment_id: 'payment_47', 
        payment_amount: 10000, 
        payment_currency: 'KZT', 
        project_id: 1234, 
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        signature: "U52k9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1...=="
    }
)

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

Callback format

The QIWI Kazakhstan method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.

The following is the example of a callback with an information about successful 10.00 KZT purchasemade by the 12346 customer in the 238 project.

 {
        "project_id": 238,
        "payment": {
            "id": "test1234567890",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "method": "Qiwi Kz Wallet",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "description": "some_string"
        },
        "account": {
            "number": "123458788"
        },
        "customer": {
            "id": "12346"
        },
        "operation": {
            "id": 32832000001400,
            "type": "sale",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "created_date": "2019-04-17T10:00:04+0000",
            "request_id": "1e4d438777e6b50c502c81473db33e3aef20d2cc-2d1e186a74b95410c320258ac79d17e7c9b3a159",
            "sum_initial": {
                "amount": 1000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1196,
                "payment_id": "999990000001a11",
                "date": "2019-04-16T19:15:00+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "SF5Kyqz4geKQdUvdWxkDu7KhOqW7a3swdACgWNdjVCL3xwqKTl
                                 0JE45Rpk1g7UIWTL5fiYoa/P7qNRSciwIbcg=="
    }
}

Related topics

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

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

General information

In the QIWI Kazakhstan 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 Monetix URL.
2. Perform redirecting customer to the QIWI Kazakhstan form.
3. 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 QIWI Kazakhstan payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the /v2/payment/wallet/qiwi-kz/sale request by using HTTP method POST. This is an e-wallets request group: /v2/payment/wallet/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • customer—object with customer information:
     • iframe—iframe mode sign
     • ip_address—IP address of the customer's device
     • id—the unique ID of the customer within your project
     • email—customer email
     • first_name—customer first name
     • last_name—customer last name
   • account—object with customer account information:
     • number—customer account number
   • payment—object with purchase information:
     • 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—code of purchase currency in the ISO-4217 alpha-3 format
   • return_url—object with the information where to redirect the customer to when the payment is completed:
     • success—the URL to redirect the customer to after the payment is successfully completed.
     • decline—the URL to redirect the customer to after the payment is declined.
3. The following parameter with the return URL is optional, but we strongly advise you to specify it in the request to provide your customer a better user experience.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • return—the URL to redirect the customer to when they prematurely terminate the payment.
4. The currency of purchase can only be KZT.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the QIWI Kazakhstan method.

{
    "general": {
        "project_id": 238,
        "payment_id": "test1234567890",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "12346",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "123458788"
    },
    "payment": {
        "amount": 1000,
        "currency": "KZT",
        "description": "some_string"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    },
    "interface_type": {
        "id": 3,
        "user": "johndoe@example.com"
    },
    "redirect_qrcode_sent": true
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the QIWI Kazakhstan service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The QIWI Kazakhstan 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 10.00 KZT purchasemade by the 12346 customer in the 238 project.

 {
        "project_id": 238,
        "payment": {
            "id": "test1234567890",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "method": "Qiwi Kz Wallet",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "description": "some_string"
        },
        "account": {
            "number": "123458788"
        },
        "customer": {
            "id": "12346"
        },
        "operation": {
            "id": 32832000001400,
            "type": "sale",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "created_date": "2019-04-17T10:00:04+0000",
            "request_id": "1e4d438777e6b50c502c81473db33e3aef20d2cc-2d1e186a74b95410c320258ac79d17e7c9b3a159",
            "sum_initial": {
                "amount": 1000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1196,
                "payment_id": "999990000001a11",
                "date": "2019-04-16T19:15:00+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "SF5Kyqz4geKQdUvdWxkDu7KhOqW7a3swdACgWNdjVCL3xwqKTl
                                 0JE45Rpk1g7UIWTL5fiYoa/P7qNRSciwIbcg=="
    }
}

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

General information

In the QIWI Kazakhstan 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the QIWI Kazakhstan 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 requests for checking account existence in the QIWI Kazakhstan method:

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",
      "project_id":111,
      "customer_id":"johndoe@example.com",
      "signature":"lY0LT8AzpR7zGce5qfYGacOuYlHGWqkMcQlqmjlsDDZI2gVcE1qVeWANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
   }

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

   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 message parameter

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

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

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 check_deposit
   • customer_id—customer identifier 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, value is always qiwi-kz;
   • signature—signature created after you specify all the required parameters

   {
      "type":"check_deposit",
      "project_id":111,
      "customer_id":"johndoe@example.com",
      "amount":10000,
      "currency":"KZT",
      "payment_method":"qiwi-kz",
      "signature":"lY0LTSAzpR7zGce5qfYGacOuYlHGWqkMcQlqmjlsDDZI2gVcE1qVeWANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
   }

3. Response to the check_deposit request must be synchronously sent and contain the following required parameters:
   • code—response code
   • payment_id—payment ID unique within the project

   Table 2. 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 message parameter

   {
      "code":0,
      "payment_id":"Asfdsaf3252345"
   }

Callback format

The QIWI Kazakhstan 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 20.00 KZT purchase made by the user9876 customer in the 238 project.

{
        "project_id": 238,
        "payment": {
            "id": "1554967098",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-11T07:18:20+0000",
            "method": "Qiwi Kz Kiosk",
            "sum": {
                "amount": 2000,
                "currency": "KZT"
            },
            "description": ""
        },
        "account": {
            "number": "user9876"
        },
        "operation": {
            "id": 36425000001206,
            "type": "sale",
            "status": "success",
            "date": "2019-04-11T07:18:20+0000",
            "created_date": "2019-04-11T07:18:19+0000",
            "request_id": "25f3114242a16ab1e010ebab4fe816b9d105ff33b90281",
            "sum_initial": {
                "amount": 2000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1197,
                "payment_id": "999990000001a1",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "HRcDJN84ghAJL2hPW9yUbVMm7SRPewQJuH+mz4gcipXc8sI
                         dToQunzSUEiy7w5vA3+MVIO8xHSNsQB5qCCm5kXA=="
    }
}

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

General information

To perform a payout through the QIWI Kazakhstan method, merchant's web service sends a request with all the required parameters and signature to Monetix URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

The sections that follow discuss in more details the request format and the Gate parameters to use in the QIWI Kazakhstan payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payouts by sending the /v2/payment/wallet/qiwi-kz/payout request by using POST (HTTP) method. This is an e-wallets request group: /v2/payment/wallet/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with customer account information:
     • number—customer account number
   • payment—object with payout information:
     • amount—payout 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—code of payout currency in the ISO-4217 alpha-3 format
3. The currency of payout can only be KZT.
4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request in the QIWI Kazakhstan method.

{
    "general": {
        "project_id": 35,
        "payment_id": "test_123",
        "signature": "kUi2x9dKHAVNU0FY"
    },
    "customer": {
        "ip_address": "198.51.100.47",
        "id":"12345",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "9182221133"
    },
    "payment": {
        "amount": 100,
        "currency": "KZT"
    }
}

Callback format

The QIWI Kazakhstan method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 100.00 KZT payout.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "qiwi-kz",
        "sum": {
            "amount": 10000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "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-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is the example of a callback for a declined payout.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "qiwi-kz",
        "sum": {
            "amount": 10000,
            "currency": "KZT"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 10000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "KZT"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

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

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

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.