Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

Countries and regions Kazakhstan
Payment currencies KZT
Payment amount limits Contact your key account manager at Rocketpay for details. Also you can check the payment amount limits in your project by using Dashboard.
Currency conversion On the Rocketpay side
Refund
Onboarding and access fee Contact your key account manager at Rocketpay for details.

Operations support

  Interfaces Payment processing time
Payment Page Gate Dashboard basic threshold
Payout * *

* Contact your key account manager at Rocketpay for the information.

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Supported mobile network operators

The table below lists the mobile network operators available for performing payout with the Mobile Commerce in Kazakhstan payment method.

Table 1. Supported mobile network operators
Mobile network operator ID
Activ ACTIV
Altel ALTEL
Beeline BEELINE
Kcell KCELL
Tele2 TELE2

Note that the list of mobile network operators in the table is provided for informational purposes only. To get the current list of mobile network operators, send a request to the payment platform as described below:

HTTP request method POST
Request body format JSON
API endpoint /v2/info/mobile/payout/list
Full API endpoint specification /v2/info/mobile/{operation_type}/list
Table 2. Parameters required in the request for the list of available mobile network operators
Object Parameter Description
general

project_id
integer strictly required

 Project ID you obtained when integrating with Rocketpay.

signature
string strictly required

 Signature created after you specify all the required parameters. For more information about, signature generation, see Signature generation and verification.

Here is an example of the data from the request for the list of available mobile network operators:

Figure: Example of the data from the request for the list of available mobile network operators

{
	"general": {
	    "project_id": 1234,
	    "signature": "K6jllym+PtObocZtr345st...=="
	}
}

Payout by using Gate

General information

To perform a payout by using Gate with the Mobile Commerce in Kazakhstan payment method:

  1. Send a request with all the required parameters and signature to the Rocketpay URL.
  2. Accept the callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the Mobile Commerce in Kazakhstan payment method.



Figure: Payout processing flow when performing a payout by using Gate

  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to Gate.
  3. The Rocketpay payment platform receives the request.
  4. The payment platform checks whether the request contains all the required parameters and correct signature.
  5. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  6. The payment platform processes the request and forwards it to the provider service.
  7. The provider service processes this request.
  8. The provider service informs the payment platform about the payout result.
  9. The payment platform sends a callback with the payout result to your system.
  10. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Mobile Commerce in Kazakhstan payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/mobile/payout
Table 3. Basic parameters of a payout request

strictly required—the parameter must be in the initial request.
Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

 Project ID you obtained from Rocketpay when integrating.

Example: 1234

payment_id
string
strictly required

 Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

 Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

 Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

 IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

 Customer's first name.

Example: John

last_name
string
strictly required

 Customer's last name.

Example: Doe

email
string
strictly required

 Customer's email.

Example: johndoe@example.com

account
object
strictly required

number
string
strictly required

 Customer's mobile phone number for receiving payout. The phone number must include a country code and must be specified without punctuation or special characters.

Example: 71234567890

payment
object
strictly required

currency
string
strictly required

 Code of the payment currency in the ISO-4217 alpha-3 format.

Example: KZT

amount
integer
strictly required

 Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 1000.00 KZT must be sent as 100000
You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the Mobile Commerce in Kazakhstan payment method:

Figure: Example of the payout request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "71234567890"
    },
    "payment": {
        "currency": "KZT",
        "amount": 100000
    }
}

Callback

In the Mobile Commerce in Kazakhstan payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.

In this payment method, callbacks also have the account object with the number and type parameters containing information about the customer's phone number and their mobile network operator.

The following is an example of a callback body with the information about a successfully completed payout.

Figure: Example of the data from a successful payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "71234567890",
        "type": "TELE2"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure: Example of the data from a declined payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "KZT"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "KZT"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KZT"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "71234567890",
        "type": "TELE2"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • 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.