QIWI Kazakhstan

Overview

QIWI Kazakhstan is payment method that allows to process payments by using e-wallets and terminals. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type
  • e-wallets
  • terminals
Countries and regions KZ
Payment currencies KZT
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 QIWI Kazakhstan payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as QIWI Kazakhstan service.



Operations support

  Interfaces Amounts, KZT Times*
Payment Page CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Purchases + +   30 days
Payouts +   24 hours
* 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 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 terminal, while to initiate a payout, you need to notify customer via merchant's web service.

Figure: Purchase by using Payment Page procedure diagram



Figure: Purchase by using Gate procedure diagram via e-wallet



Figure: Purchase by using Gate procedure diagram via terminal



Figure: Payout by using Gate procedure diagram



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.

Purchase by using Payment Page

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 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 QIWI Kazakhstan 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 QIWI Kazakhstan payment method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. Form for entering a mobile phone number is displayed to the customer.
  9. The customer enters phone number that is linked to the QIWI Kazakhstan account.
  10. The payment platform receives the purchase request for payment processing.
  11. The payment platform performs the internal purchase request processing and sends invoice request to the QIWI Kazakhstan service.
  12. The invoice request is processed on the QIWI Kazakhstan service side.
  13. The QIWI Kazakhstan service sends invoice data to the payment platform.
  14. The payment platform sends the customer redirection data to Payment Page.
  15. The customer is redirected to the QIWI Kazakhstan payment form.
  16. The customer completes all the payment steps required.
  17. QIWI Kazakhstan service sends request for checking customer account existence to the payment platform.
  18. Information about customer account existence is sent to the QIWI Kazakhstan service.
  19. The payment is processed on the QIWI Kazakhstan side.
  20. QIWI Kazakhstan service sends the payment result notification to the payment platform.
  21. The payment platform sends the callback to the web service.
  22. The payment platform sends payment results to Payment Page.
  23. A page with the payment result information is displayed to the customer.

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 mandatory for any payment method:
    • 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
    • customer_id—customer ID unique within the project
  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.

Thus, a correct payment request in the QIWI Kazakhstan method must include project and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { project_id: 0, 
      payment_id: 'X03936', 
      customer_id: 'user123',
      payment_amount: 10000, 
      payment_currency: 'KZT', 
      signature: "jgsfh2x9dKHAVNU0FYldJrxh4yo+52Kt8K59Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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.

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.

Figure: Example of a successful purchase callback

 {
        "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:

Purchase by using Gate via e-wallet

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



Figure: Purchase sequence by using Gate via e-wallet

  1. Customer initiates purchase on the merchant web service by using QIWI Kazakhstan method.
  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 to the web service response with request receipt confirmation and correctness check result.
  6. The payment platform performs the internal payment request processing and sends invoice request to the QIWI Kazakhstan service.
  7. The invoice request is processed on the QIWI Kazakhstan side.
  8. The QIWI Kazakhstan service sends invoice data to the payment platform.
  9. The payment platform sends to the web service the callback that delivers the data for redirecting customer to the QIWI Kazakhstan service.
  10. The customer is redirected to the QIWI Kazakhstan payment form.
  11. The customer completes all the payment steps required.
  12. QIWI Kazakhstan service sends request for checking customer account existence to the payment platform.
  13. Information about customer account existence is sent to the QIWI Kazakhstan service.
  14. The payment is processed on the QIWI Kazakhstan side.
  15. The QIWI Kazakhstan service sends the payment result notification to the payment platform.
  16. The payment platform sends the 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 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 purchase requests in the QIWI Kazakhstan method:
  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:
    • Object general—general purchase 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:
      • iframe—iframe mode sign
      • ip_address—customer IP address
      • id—the ID of the customer within the merchant project
    • Object account—customer account information:
      • number—customer account number
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format.
  3. The currency of purchase can only be KZT.
  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 QIWI Kazakhstan method project and payment IDs, account number, sign of the iframe mode, customer IP address, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 238,
    "payment_id": "test1234567890",
    "signature": "wsPEeK7EczGLgnIDqQ3qbrU54uGKjqSIfd56KHsKGnHcCS
                     Zs0N5wSbxK+AD5XbckdDEytGpOkC95GLTNVkpCWQ=="
  },
  "customer": {
    "id": "12346",
    "ip_address": "1.2.3.4",
    "id": "123"
  },
  "account": {
    "number": "123458788"
  },
  "payment": {
    "amount": 1000,
    "currency": "KZT",
    "description": "some_string"
  },
  "return_url": {
    "success": "http:success.url",
    "decline": "http:decline.url"
  },
  "interface_type": {
    "id": 3,
    "user": "test@gmail.com"
  },
  "redirect_qrcode_sent": true
}

Formats of the customer redirection data

To redirect a customer from the web service to the QIWI Kazakhstan service, 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 bank’s HTML page using method specified in the redirect_data.method parameter.

Callback format

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

Figure: Example of a successful purchase callback

 {
        "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:

Purchase by using Gate via terminal

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.



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 QIWI Kazakhstan service.
  8. The QIWI Kazakhstan payment form is displayed to the customer.
  9. The customers pays by cash to replenish personal account.
  10. The payment is processed on the QIWI Kazakhstan side.
  11. The QIWI Kazakhstan 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 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 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":"ov_ole8@mail.ru",
       "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

    Figure: Example of the response

    {
       "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 ECommPay
    • amount—purchase amount in minor units
    • currency—currency in the ISO-4217 alpha-3 format
    • payment_method—payment method name, value is always qiwi-kz;
    • siganture—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":"ov_ole8@mail.ru",
       "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

    Figure: Example of the response

    {
       "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.

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.

Figure: Example of a successful purchase callback

{
        "project_id": 238,
        "payment": {
            "id": "1554967098",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-11T07:18:20+0000",
            "method": "Qiwi Kz Terminal",
            "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:

Payout by using Gate

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 ECommPay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure: Payout sequence by using Gate

  1. A customer orders a payout through the QIWI Kazakhstan service.
  2. Merchant's web service sends the payout request for processing the payout 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 check 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 QIWI Kazakhstan service.
  7. The payout is processed on the QIWI Kazakhstan side.
  8. QIWI Kazakhstan 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 payout result from the web service.

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

There are several things you must consider when using payout requests in the QIWI Kazakhstan method:
  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:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • 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—identifier
      • ip_address—IP address
    • Object account—customer account information:
      • number—customer account number
    • Object payment—payout information:
      • amount—payout amount
      • currency—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.

Thus, a correct payment request in the QIWI Kazakhstan method must include project, customer, and payment IDs, account number (for crediting), customer IP address, currency and amount of the payout, as shown in the following example:

Figure: Example of a payout request

{
  "general": {
    "project_id": 35,
    "payment_id": "test_123",
    "signature": "kUi2x9dKHAVNU0FY"
  },
  "customer": {
    "ip_address": "185.123.193.224",
    "id":"12345",
    "account": "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.

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