Purchase
When performing a purchase, the customer is redirected to the bank service where they make a purchase.
Countries and regions | Cambodia |
Payment currencies | 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. |
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.
Purchase by using Payment Page
General information
To perform a purchase by using Payment Page with the Banks of 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 Banks of 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 Banks of Cambodia payment method.
- The payment platform processes the request and forwards it to the bank service.
- The bank service sends the customer redirection data to the payment platform.
- The checkout page redirects the customer to the bank service.
- The customer completes the purchase.
- The customer is redirected back to the checkout page.
- The bank 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 Banks of 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's 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: 100.00 USD must be sent as | |
force_payment_method | Parameter that allows you to enforce the Banks of Cambodia payment method for your customer and skip the page with payment method selections. To enforce the Banks of 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. | |
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: 'USD', payment_amount: 10000, force_payment_method: 'banks-cambodia', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==' } )
Callback
In the Banks of 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": "Banks Cambodia",
"sum": {
"amount": 10000,
"currency": "USD"
},
"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": 10000,
"currency": "USD"
},
"sum_converted": {
"amount": 10000,
"currency": "USD"
},
"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": "Banks Cambodia",
"sum": {
"amount": 10000,
"currency": "USD"
},
"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": 10000,
"currency": "USD"
},
"sum_converted": {
"amount": 10000,
"currency": "USD"
},
"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 Banks of Cambodia payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Redirect the customer to the bank service.
- Accept the callback with the purchase result from the payment platform.
The following figure provides the details of the purchase processing flow in the Banks of 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 bank service.
- The bank service sends the customer redirection data to the payment platform.
- The payment platform forwards the data to your system in the redirect_data object.
- Your system redirects the customer to the bank service.
- The customer completes the purchase.
- The customer is redirected to your system.
- The bank 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 Banks of Cambodia payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/banks/cambodia/sale |
Full API endpoint specification | /v2/payment/banks/{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 | bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase. Example: | |
customer_name | Customer's 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: 100.00 USD must be sent as | ||
return_url | success | The URL to redirect the customer to after the payment is successfully completed. Example: | |
decline | The URL to redirect the customer to after the payment is declined. Example: | ||
return | The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix. Example: | ||
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 Banks of 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": { "bank_id": 61021, "customer_name": "John Doe" }, "payment": { "currency": "USD", "amount": 10000 }, "return_url": { "success": "https://example.com/success/", "decline": "https://example.com/decline/", "return": "https://example.com/return/" } }
Customer redirection
After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the bank 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 send in the request body
- method—the HTTP method for retrieving the website page (for example,
POST
orGET
) - encrypted—this is the service parameter. Ignore it.
Here is an example of the callback snippet with the data to redirect the customer.
"redirect_data": { "method": "GET", "body": [], "encrypted": [], "url": "https://example.com/redirect" }
Callback
In the Banks of 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": "Banks Cambodia",
"sum": {
"amount": 10000,
"currency": "USD"
},
"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": 10000,
"currency": "USD"
},
"sum_converted": {
"amount": 10000,
"currency": "USD"
},
"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": "Banks Cambodia",
"sum": {
"amount": 10000,
"currency": "USD"
},
"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": 10000,
"currency": "USD"
},
"sum_converted": {
"amount": 10000,
"currency": "USD"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Banks available for purchase
Supported banks
In the Banks of Cambodia payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.
The table below lists the banks available for purchase in the Banks of Cambodia payment method.
Bank | ID |
---|---|
ABA PAY | 62401 |
ACLEDA Bank | 62411 |
Sathapana | 62391 |
Wing Bank | 61021 |
The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Banks of Cambodia payment method supports, send a request to the payment platform.
Request for the list of available banks
This section provides the instructions on how to build the request for the list of banks supported in the Banks of Cambodia payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint |
/v2/info/banks/banks/cambodia/sale/list
|
Full API endpoint specification | /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained when integrating with Monetix.
Example: |
|
payment_id |
Payment ID unique within the project.
If the payment is not yet created, set this parameter to a unique value. Example: |
||
signature |
Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification. | ||
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: 100.00 USD must be sent as |
|
currency |
Code of the purchase currency in the ISO-4217 alpha-3 format.
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 list of banks available in the Banks of Cambodia payment method.
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jll2ym+PtOb3ocZtr345st...==" }, "payment": { "amount": 10000, "currency": "USD" } }
[ { "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units) "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units) "limitCurrency": "USD", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format "id": 123, // Bank ID "abbr": "EXB", // Bank shortcut name (for internal use) "name": "Example Bank", // General bank name "nativeName": "Example Bank", // Native bank name "currencies": [ // Array with currencies supported by the bank { "id": 123, // Currency ID in the payment platform "alpha_3_4217": "USD", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format "currency_type": "fiat", // Type of the currency "exponent": 2 // Number of decimal places after decimal point } ] } ]