Purchase
When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).
Countries and regions | Cambodia |
Payment currencies | KHR, USD |
Payment amount limits | Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard. |
Payment processing time | Contact your key account manager at Monetix for details. |
Currency conversion | On the Monetix side |
Refund | |
Onboarding and access fee | Contact your key account manager at Monetix for details. |
Special considerations
|
Operations support
Interfaces | |||
---|---|---|---|
Payment Page | Gate | Dashboard | |
Purchase |
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 banks
Payments through the Bank transfers in Cambodia method are carried out through the banks that support the method. To initiate a purchase by using Gate, you use the bank identifiers which are also used to display banks on Payment Page where your customer can choose a payment method.
The tables below provide information about supported banks.
Bank | ID |
---|---|
ABA Bank (Cambodia) | 60891 |
The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.
Purchase by using Payment Page
General information
To perform a purchase by using Payment Page with the Bank transfers in Cambodia payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept the callback with the purchase result from the payment platform.
The following figure shows the complete purchase processing flow in the Bank transfers in Cambodia payment method.
- The customer initiates a purchase in your system.
- Your system sends the request for the purchase through Payment Page to the Monetix URL.
- The checkout page is displayed to the customer.
- The customer chooses to make a purchase with the Bank transfers in Cambodia payment method.
- The payment platform forwards the request to the provider service.
- The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
- The checkout page displays the payment instructions to the customer.
- The customer completes 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 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 Bank transfers in Cambodia payment method.
|
||
---|---|---|
Parameter | Description | |
project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | |
customer_id | Unique ID of the customer within your project. Example: | |
customer_email | Customer's email. Example: | |
account_customer_name | Customer full name. 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: 50,000.00 KHR must be sent as | |
force_payment_method | Parameter that allows you to enforce the Bank transfers in Cambodia payment method for your customer and skip the page with payment method selections. To enforce the Bank transfers in Cambodia 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. | |
language_code | By default, the messages with information about payment result are displayed in Khmer language. To change the language of the messages to English, add to your request the language_code parameter set to en .Example: | |
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_email: 'johndoe@example.com', account_customer_name: 'John Doe', payment_currency: 'KHR', payment_amount: 5000000, force_payment_method: 'bank-transfer-cambodia', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==', language_code: 'en' } )
Callback
In the Bank transfers in Cambodia payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.
The following is an example of a callback body with information about a successfully completed purchase.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer Cambodia",
"sum": {
"amount": 5000000,
"currency": "KHR"
},
"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": 5000000,
"currency": "KHR"
},
"sum_converted": {
"amount": 5000000,
"currency": "KHR"
},
"code": "0",
"message": "Success",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined purchase.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer Cambodia",
"sum": {
"amount": 5000000,
"currency": "KHR"
},
"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": 5000000,
"currency": "KHR"
},
"sum_converted": {
"amount": 5000000,
"currency": "KHR"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Purchase by using Gate
General information
To perform a purchase by using Gate with the Bank transfers in Cambodia payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Show the screen with payment instructions to the customer.
- Accept the callback with the purchase result from the payment platform.
The following figure provides the details of the purchase processing flow in the Bank transfers in Cambodia payment method.
- The customer initiates a purchase in your system.
- Your system sends the purchase request to the Monetix payment platform.
- 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 generates the payment instructions to show to the customer and sends them to the payment platform.
- The payment platform forwards the instructions to your system in the display_data array.
- Your system displays the payment instructions to the customer.
- The customer completes 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 Bank transfers in Cambodia payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/bank-transfer/cambodia/sale |
Full API endpoint specification | /v2/payment/bank-transfer/{payment_method}/sale |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general | project_id | Project ID you obtained from Monetix 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: | ||
email | Customer's email. Example: | ||
account | customer_name | Customer full name. 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: 50,000.00 KHR 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 Bank transfers in Cambodia payment method:
{ "general": { "project_id": 1234, "payment_id": "payment_47", "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==" }, "customer": { "id": "customer_123", "ip_address": "198.51.100.47", "email": "johndoe@example.com" }, "account": { "customer_name": "John Doe" }, "payment": { "currency": "KHR", "amount": 5000000 } }
Format of the data for displaying the payment instructions
After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.
Use the data from the display_data array to display the payment instructions to the customer.
Element | Description |
---|---|
|
Operation number. This element is always presented in display_data array. Example: |
|
Payment amount to show in the payment instructions. This element is always presented in display_data array. Example: |
|
Bank code. This element is always presented in display_data array. Example: |
|
Payment recipient account. This element is always presented in display_data array. Example: |
|
Bank name. This element is always presented in display_data array. Example: |
|
The link to display the QR code. This parameter may be not presented in the display_data array. Contact your key account manager at Monetix to find out if this element will be displayed to your customer. Example: |
The following is a sample callback snippet with the display_data array.
"display_data": [ { "type": "add_info", "title": "invoice_number", "data": "12345678901234" }, { "type": "add_info", "title": "payment_amount_show", "data": "20000.00" }, { "type": "add_info", "title": "bank_code", "data": "KBZ" }, { "type": "add_info", "title": "account_number", "data": "123-456-789-012-34567" }, { "type": "add_info", "title": "bank_name", "data": "KBZ" }, { "type": "qr_url", "title": "qr_url", "data": "https://example.com/qr.png" } ]
Callback
In the Bank transfers in Cambodia payment method, the payment platform returns the purchase 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 purchase.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer Cambodia",
"sum": {
"amount": 5000000,
"currency": "KHR"
},
"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": 5000000,
"currency": "KHR"
},
"sum_converted": {
"amount": 5000000,
"currency": "KHR"
},
"code": "0",
"message": "Success",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined purchase.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "Bank transfer Cambodia",
"sum": {
"amount": 5000000,
"currency": "KHR"
},
"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": 5000000,
"currency": "KHR"
},
"sum_converted": {
"amount": 5000000,
"currency": "KHR"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}