Purchase
When performing a purchase, the customer uses a code the mobile network operator sends them to confirm the payment.
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. |
Special considerations Contact your key account manager at Rocketpay to find out whether refunds are available in your case. |
Operations support
Interfaces | Payment processing time | ||||
---|---|---|---|---|---|
Payment Page | Gate | Dashboard | basic | threshold | |
Purchase | * | * | |||
Refund | * | * |
* 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 purchase with the Mobile Commerce in Kazakhstan payment method.
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/sale/list |
Full API endpoint specification | /v2/info/mobile/{operation_type}/list |
Object | Parameter | Description |
---|---|---|
general | project_id |
Project ID you obtained when integrating with Rocketpay. |
signature |
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...==" } }
Purchase by using Payment Page
General information
To perform a purchase by using Payment Page with the Mobile Commerce in Kazakhstan payment method:
- Send a request with all the required parameters and signature to the Rocketpay URL.
- Accept the callback with the purchase result from the payment platform.
The following figure shows the complete purchase processing flow in the Mobile Commerce in Kazakhstan payment method.
Figure: Purchase processing steps for a purchase by using Payment Page
- The customer initiates a purchase in your system.
- Your system sends the request for the purchase through Payment Page to the Rocketpay URL.
- The Rocketpay payment platform receives the request.
- The payment platform processes the request and checks whether it contains all the required parameters and the signature is correct.
- The payment platform creates the checkout page based on the project settings and request parameters.
- The checkout page is displayed to the customer.
- The customer chooses to make a purchase with the Mobile Commerce in Kazakhstan payment method.
- Payment Page forwards the purchase request to the payment platform.
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the purchase request.
- The mobile network operator service sends a message with the OTP to the customer.
- Payment Page displays the screen for the customer to enter the OTP.
- The customer enters the OTP.
- Payment Page forwards the request with the OTP to the payment platform.
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the purchase.
- The provider service sends the purchase result information to the payment platform.
- The payment platform sends a callback with the payment result to your system.
- The payment platform sends the payment result to Payment Page.
- Payment Page displays the payment result to the customer on the checkout page.
Request
The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Mobile Commerce in Kazakhstan payment method.
|
||
---|---|---|
Parameter | Description | |
project_id |
Project ID you obtained from Rocketpay when integrating. Example: |
|
payment_id |
Payment ID unique within your project. Example: |
|
customer_id |
Unique ID of the customer within your project. Example: |
|
customer_first_name |
Customer's first name. Example: |
|
customer_last_name |
Customer's last name. Example: |
|
customer_email |
Customer's email. Example: |
|
payment_currency |
Code of the payment currency in the ISO-4217 alpha-3 format.
Example: |
|
payment_amount |
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 |
|
force_payment_method |
Parameter that allows you to enforce the Mobile Commerce in Kazakhstan payment method for your customer and skip the page with payment method selections. To enforce the Mobile Commerce in Kazakhstan payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to Example: |
|
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | |
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters. |
Here is an example of the data from a request to open the checkout page by using
EPayWidget
:
EPayWidget.run( { project_id: 1234, payment_id: 'payment_47', customer_id: 'customer_123', customer_first_name: 'John', customer_last_name: 'Doe', customer_email: 'johndoe@example.com', payment_currency: 'KZT', payment_amount: 100000, force_payment_method: 'mobile', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==' } )
You can enforce a mobile network operator for your customer on the checkout page. To do so, add the following parameters to the request for the checkout page opening:
Object/parameter | Parameter | Description |
---|---|---|
force_payment_method |
Parameter that allows you to enforce the Mobile Commerce in Kazakhstan payment method for your customer and skip the page with payment method selections. Set the value of this parameter to Example: |
|
payment_methods_options |
enable_mobile_service |
Set the value of this parameter to 1 to enable enforcing mobile network operator on the checkout page. |
selected_operator |
ID of the customer's mobile network operator. For the information on how to get the list of supported mobile network operators IDs, see Supported mobile network operators. Example: |
Here is an example of the data from the request to open the checkout page with a mobile network operator enforced for the customer:
EPayWidget.run( { project_id: 1234, payment_id: 'payment_47', customer_id: 'customer_123', customer_first_name: 'John', customer_last_name: 'Doe', customer_email: 'johndoe@example.com', payment_currency: 'KZT', payment_amount: 100000, force_payment_method: 'mobile', payment_methods_options: {"enable_mobile_service": 1, "selected_operator": "TELE2"}, signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==' } )
Callback
In the Mobile Commerce in Kazakhstan payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.
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 information about a successfully completed purchase.
Figure: Example of the data from a successful purchase callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"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": "sale",
"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 purchase.
Figure: Example of the data from a declined purchase callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"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": "sale",
"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=="
}
Purchase by using Gate
General information
To perform a purchase by using Gate with the Mobile Commerce in Kazakhstan payment method:
- Send a request with all the required parameters and signature to the Rocketpay URL.
- Receive a callback with the data you're required to submit.
- Send a request with the data to the Rocketpay payment platform.
- Accept the callback with the purchase result from the payment platform.
The following figure provides the details of the purchase processing flow in the Mobile Commerce in Kazakhstan payment method.
Figure: Purchase processing flow when performing a purchase by using Gate
- The customer initiates a purchase in your system.
- Your system sends the purchase request to Gate.
- The Rocketpay payment platform receives the request.
- The payment platform checks whether the request contains all the required parameters and correct signature.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the purchase request.
- The mobile network operator service generates the OTP and sends it to the customer in a message.
- The payment platform sends your system a callback with the data your system is required to submit.
- The customer enters the OTP in your system.
- Your system sends the request with the OTP to the payment platform.
- The payment platform receives the request.
- The payment platform checks whether the request contains all the required parameters and correct signature.
- The payment platform sends your system the response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
- The payment platform forwards the OTP to the provider service.
- The provider service processes the purchase.
- The provider service informs the payment platform about the purchase result.
- The payment platform sends the callback with the payment result to your system.
- Your system sends the payment result to the customer.
Request
This section provides the instructions on how to build the request for purchase with the Mobile Commerce in Kazakhstan payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/mobile/sale |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained from Rocketpay when integrating. Example: |
|
payment_id |
Payment ID unique within your project. Example: |
||
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer |
id |
Unique ID of the customer within your project. Example: |
|
ip_address |
IP address of the customer's device. Example: |
||
first_name |
Customer's first name. Example: |
||
last_name |
Customer's last name. Example: |
||
email |
Customer's email. Example: |
||
account |
number |
Customer's mobile phone number. The phone number must include a country code and must be specified without punctuation or special characters. Example: |
|
payment |
currency |
Code of the payment currency in the ISO-4217 alpha-3 format. Example: |
|
amount |
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 |
||
You can also add any other optional parameters to the purchase 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 purchase with the Mobile Commerce in Kazakhstan payment method:
Figure: Example of the purchase 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 } }
Submitting the OTP to the payment platform
After you received the OTP from the customer, you need to send it to the payment platform in a new request. Listed below are the instructions on how to build the request with the OTP.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/clarification |
|
||||
---|---|---|---|---|
Object | Object/Parameter | Description | ||
general |
project_id |
Project ID you obtained from Rocketpay when integrating. Example: |
||
payment_id |
Payment ID unique within your project. Example: |
|||
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | |||
additional_data |
additional_data |
approval_code |
The OTP the customer receives in a message from the mobile network operator. Example: |
|
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference. |
Here is an example of the data from the request with the OTP:
Figure: Example of the data from a request with the OTP
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==" }, "additional_data": { "additional_data": { "approval_code": "123456" } } }
For the mobile network operator to confirm the payment on time, it is recommended to send a request with the OTP within 80 or 90 seconds after you've received a callback notifying that you're required to submit the OTP your customer's received (contact your key account manager at Rocketpay to get the OTP expiry time relevant in your case).
After the request is sent, the payment processing may continue as follows:
- If the OTP is correct and sent on time, the payment processing continues on the side of the payment platform, provider service, and mobile network operator service. You will receive a final callback with the payment result after the payment processing is complete.
- If the OTP is sent on time but is incorrect, the payment platform resends your system a callback notifying that you're required to submit the OTP. In this case you should provide the customer with an opportunity to specify the correct OTP once more and send a request with this OTP to the payment platform (also within 80 or 90 seconds).
If the OTP is sent after 80 or 90 seconds, the following options are possible:
- If the OTP is correct and sent on time to be processed by the mobile network operator, the payment processing continues on the side of the payment platform, provider service, and mobile network operator service. You will receive a final callback with the payment result after the payment processing is complete.
- If the OTP is incorrect or expired, the payment platform resends your system a callback notifying that you're required to submit the OTP. In this case it is recommended that you send the payment platform a request for sending a new OTP to the customer, then receive the new OTP from the customer, and send it in a request to the payment platform.
Request for the new OTP to be sent to the customer
You can request a new OTP to be sent to the customer 80 or 90 seconds after the previous OTP was created on the mobile network operator side (contact your key account manager at Rocketpay to get the OTP expiry time relevant in your case).
To request a new OTP to be sent to the customer, send a request to the Rocketpay payment platform. Listed below are the instructions on how to build such a request.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/customer/action/resend |
Full API endpoint specification | /v2/customer/action/{action_name} |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained from Rocketpay when integrating. Example: |
|
payment_id |
Payment ID you request the new OTP to be sent for. Example: |
||
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer |
ip_address |
IP address of the customer's device. Example: |
|
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference. |
Here is an example of the data from the request for the new OTP to be sent to the customer:
Figure: Example of the data from a request for the new OTP to be sent to the customer
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW/9MTO8yJA==" }, "customer": { "ip_address": "198.51.100.47" } }
You can request new OTPs to be sent to the customer up to three times. Each of the OTPs sent to the customer is valid within 80 or 90 seconds after they were created on the mobile network operator side (contact your key account manager at Rocketpay to get the OTP expiry time relevant in your case).
Callback
In the Mobile Commerce in Kazakhstan payment method, the payment platform returns the purchase 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 purchase.
Figure: Example of the data from a successful purchase callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"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": "sale",
"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 purchase.
Figure: Example of the data from a declined purchase callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"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": "sale",
"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=="
}
Refund by using Gate
General information
To perform a refund by using Gate for a purchase made with the Mobile Commerce in Kazakhstan payment method:
- Send a request with all the required parameters and signature to the Rocketpay URL.
- Accept the callback with the refund result from the payment platform.
The following picture provides all the details of the refund processing flow in the Mobile Commerce in Kazakhstan payment method.
Figure: Refund processing flow when performing a refund by using Gate
- The customer initiates a refund in your system.
- Your system sends the request for refund to Gate.
- The Rocketpay payment platform receives the request.
- The payment platform checks whether the request contains all the required parameters and the correct signature.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service processes the refund request.
- The provider service informs the payment platform about the refund result.
- The payment platform sends you the callback with the refund result.
- Your system sends the refund result to the customer.
Request
This section provides the instructions on how to build the request for refund with the Mobile Commerce in Kazakhstan payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/mobile/refund |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained from Rocketpay when integrating. Example: |
|
payment_id |
ID of the payment the refund is performed for Example: |
||
signature |
Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
payment |
currency |
Code of the payment currency in the ISO-4217 alpha-3 format. This parameter is required when performing a partial refund. Example: KZT |
|
amount |
Refund 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. This parameter is required when performing a partial refund. Example: 1000.00 KZT must be sent as |
||
description |
Refund description. Example: |
||
You can also add any other optional parameters to the refund 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 refund with the Mobile Commerce in Kazakhstan payment method:
Figure: Example of the refund request body
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==" }, "payment": { "currency": "KZT", "amount": 100000, "description": "Refund." } }
Callback
In the Mobile Commerce in Kazakhstan payment method, the payment platform returns the refund result in a callback. For the information about the callback structure, see Callbacks in Gate.
The following is an example of a callback body with the information about a successfully completed refund.
Figure: Example of the body of a successful refund callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "refunded",
"date": "2024-12-07T19:08:45+0000",
"method": "mobile",
"sum": {
"amount": 0,
"currency": "KZT"
},
"description": ""
},
"customer": {
"id": "customer_123"
},
"operation": {
"id": 47,
"type": "refund",
"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 refund.
Figure: Example of the data from a declined refund callback
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"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": "refund",
"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=="
}