Cambodia QR Banking
Overview
Cambodia QR Banking is a payment method that allows customers to perform payments in Cambodia by scanning QR codes with mobile banking applications. A payment is credited immediately after a customer confirms the payment by entering OTP or predefined payment code within secure environment of the app. Purchases are performed by using Payment Page and Gate. Download the logo in vector format here. |
Payment method type | Payments by using QR code |
---|---|
Countries and regions | Cambodia |
Payment currencies | KHR |
Currency conversion | On the Monetix side |
Purchases | |
Payouts | Available by using the Banks of Cambodia payment method |
COF payments | |
Full refunds | |
Partial refunds | |
Chargebacks | |
Notes | |
Onboarding and access fee | Refer to your Monetix key account manager |
Interaction diagram
Payment processing by using the Cambodia QR Banking payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as one of the bank services which supports this payment method.
Operations support
* Refer to your Monetix key account manager for more 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 click the Payment methods tab.
Processing scenarios
In the Cambodia QR Banking method, the customer is required to scan QR code by using bank mobile application. Refer to your key account manager at Monetix to find out the details of the payment scenario.
The sections that follow provide detailed information about what you need to perform payments and how you can analyze the information on payments and operations.
Supported banks
Payments through the Cambodia QR Banking method are carried out through the banks that support the method. To initiate purchase by using Gate, you use bank identifiers, which are also used to display banks on Payment Page where your customer can choose payment method.
The tables below provide information about supported banks.
Bank | ID |
---|---|
ABA Bank (Cambodia) | 60891 |
Purchase by using Payment Page
General information
In the Cambodia QR Banking method, to perform a purchase by using Payment Page, the merchant web service is required to send a request with all the required parameters and signature to the Monetix URL and accept the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Cambodia QR Banking method preselected. For more information about preselecting payment methods, see Preselecting payment methods.
The full sequence and particularities of the purchase process are provided below.
- Customer initiates a purchase on the merchant's web service.
- The web service sends the request for the Payment Page opening to the Monetix URL.
- The request for opening Payment Page is redirected to the payment platform.
- The payment platform performs the initial request processing that involves validation of the required parameters and signature.
- The requested Payment Page is generated by the Monetix payment platform as specified in the project settings and request parameters.
- Payment Page is displayed to the customer.
- The customer selects the Cambodia QR Banking payment method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
- The payment platform receives the purchase request for the payment processing from Payment Page.
- The payment platform performs the internal purchase request processing and sends it to the bank service.
- The bank service processes the request.
- The bank service generates the data for displaying a QR code to the customer and sends it to the payment platform.
- The payment platform sends to Payment Page the data for displaying the QR code to the customer.
- The QR code is displayed to the customer on Payment Page.
- The customer scans the QR code by using the bank mobile app and completes all the steps required for the payment.
- The bank service processes the payment.
- The bank service sends the result notification to the payment platform.
- The payment platform sends callback with the payment result to the web service.
- The payment platform sends the result to Payment Page.
- The page with the payment result information is displayed to the customer on Payment Page.
The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Cambodia QR Banking payment method and provide the information about the format of callbacks with payment results. For the general information on how to use the Payment Page API, see Payment Page API Description.
Request format
There are several things you need to consider when using the Cambodia QR Banking method:
- You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
- project_id—the project ID obtained from Monetix
- payment_id—payment ID unique within the project
- customer_id—unique ID of the customer within your project
- customer_email—customer email address
- payment_currency—code of payment currency in ISO-4217 alpha-3 format
- payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
- account_customer_name—customer full name
- If you need to have payment form displayed with the Cambodia QR Banking method preselected, set the
force_payment_method
parameter tobanks-cambodia-qr
. - 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
. - If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Cambodia QR Banking method, see Payment Page invocation parameters.
- After you specify all the parameters you need, you are required to create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.
Here is an example of data from a request for Payment Page opening:
EPayWidget.run( { project_id: 1234, payment_id: 'payment_123', customer_id: 'customer_123', customer_email: 'johndoe@example.com', account_customer_name: 'John Doe', payment_amount: 5000000, payment_currency: 'KHR', signature: "kUi2x9dKHAVNU0FYldJrxhRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Callback format
The Cambodia QR Banking method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.
The following is the example of a callback with an information about successful 50,000.00
KHR
purchase made in the 1234
project.
{ "project_id": 1234, "payment": { "id": "1561223423", "type": "purchase", "status": "success", "date": "2019-07-01T07:54:16+0000", "method": "Cambodia qr", "sum": { "amount": 5000000, "currency": "KHR" }, "description": "1561714332889" }, "customer": { "id": "customer_123" }, "operation": { "id": 39811000003358, "type": "sale", "status": "success", "date": "2019-07-01T07:54:16+0000", "created_date": "2019-07-01T07:53:19+0000", "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff", "sum_initial": { "amount": 5000000, "currency": "KHR" }, "sum_converted": { "amount": 5000000, "currency": "KHR" }, "code": "0", "message": "Success" }, "signature": "YreiJ0aXQgDVuo74tsBXVRcd/0M9twm5IDxiZ8C2sqcuuncjkbazWKg==" } }
The following is the example of a callback for a declined purchase.
{ "project_id": 200, "payment": { "id": "1561223423", "type": "purchase", "status": "decline", "date": "2019-07-01T07:54:16+0000", "method": "Cambodia qr", "sum": { "amount": 5000000, "currency": "KHR" }, "description": "1561714332889" }, "customer": { "id": "customer_123" }, "operation": { "id": 39811000003358, "type": "sale", "status": "success", "date": "2019-07-01T07:54:16+0000", "created_date": "2019-07-01T07:53:19+0000", "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff", "sum_initial": { "amount": 5000000, "currency": "KHR" }, "sum_converted": { "amount": 5000000, "currency": "KHR" }, "code": "20000", "message": "General decline" }, "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVCy9twm5IDxiZ8C2sqcuuncjkbazWKg==" } }
Related topics
The following topics might be useful when implementing payments by using Payment Page:
Purchase by using Gate
General information
In the Cambodia QR Banking method, to perform a purchase by using Gate, the merchant web service is required to do the following:
- Send a request with all the required parameters and signature to the Monetix URL.
- Display the QR code to the customer.
- Accept the callback with the payment result from the payment platform.
The following diagram provides the detailed picture of the payment processing procedure.
- Customer initiates a purchase with Cambodia QR Banking on the merchant's web service side.
- The web service sends a request for processing the purchase by using Gate to the Monetix URL.
- The payment platform receives the request for processing the purchase from Gate.
- The payment platform performs the initial request processing that includes validation of the required parameters and signature.
- The payment platform sends the response with the request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
- The payment platform performs the internal payment request processing and redirects the request to the bank service.
- The bank service processes the purchase request.
- The bank service generates the data for displaying a QR code to the customer and sends it to the payment platform.
- The payment platform sends to the web service the callback that delivers the data for displaying the QR code.
- The QR code is displayed to the customer on the web service side.
- The customer scans the QR code by using the bank mobile app and completes all the steps required for the payment.
- The bank service processes the payment.
- The bank service sends the payment result to the customer.
- The bank service sends the payment result notification to the payment platform.
- The payment platform sends the callback with the payment result to the web service.
- The web service sends the payment result to the customer.
The sections that follow discuss in more details the request format and the Gate parameters to use in the Cambodia QR Banking 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 Cambodia QR Banking method:
- You initiate a purchase by submitting a purchase request to the
/v2/payment/banks/cambodia-qr/sale
endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the online banking payments: /v2/payment/banks/{payment_method}/sale. - The following objects and parameters must be specified in any request:
- general—object with general request identification information:
- project_id—the project ID obtained from Monetix
- 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.
- customer—object with customer information:
- id—the unique ID of the customer within your project
- ip_address—customer device IP
- email—customer email address
- payment—object with purchase information:
- amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
- currency—code of purchase currency in ISO-4217 alpha-3 format
- account—object with customer account information:
- customer_name—customer's full name
- bank_id—ID of the bank
- general—object with general request identification information:
- If required, you can also add any optional parameters Gate supports.
Here is an example of data from a purchase request in the Cambodia QR Banking method.
{ "general": { "project_id": 1234, "payment_id": "payment_123", "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCruECSyQEbT1hSXJ70zuH4...==" }, "customer": { "ip_address": "198.51.100.47", "id": "customer_123", "email": "johndoe@example.com" }, "account": { "customer_name": "John Doe", "bank_id": 12345 }, "payment": { "amount": 5000000, "currency": "KHR" } }
Format of the data for displaying QR code to customers
In order to customer is able to complete the payment, you are required to display the QR code in your web service. The QR code data is sent in the callback from the payment platform in the data parameter of display_data array. The data should be displayed to the customer in the QR code. Therefore, before displaying the QR code, you need to accept and process such callback.
There is only one element in the display_data array and it contains the following parameters:
- type—element type (always
qr_url
) - title—the name of the data, the value is always
qr_url
- data—the data that should be encoded in the QR code
The following is the callback fragment containing display_data array.
"display_data": [ { "type": "qr_url", "title": "qr_url", "data": "https://crm.sample.com/file/bank/qr/KHR_QR_RIEL_WITHOUTLOGO.jpg?v=1" } ]
Callback format
The Cambodia QR Banking method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Gate.
The following is the example of a callback with an information about successful 50,000.00 KHR
purchase made in the 1234
project.
{ "project_id": 1234, "payment": { "id": "1561223423", "type": "purchase", "status": "success", "date": "2019-07-01T07:54:16+0000", "method": "Cambodia qr", "sum": { "amount": 5000000, "currency": "KHR" }, "description": "1561714332889" }, "customer": { "id": "customer_123" }, "operation": { "id": 39811000003358, "type": "sale", "status": "success", "date": "2019-07-01T07:54:16+0000", "created_date": "2019-07-01T07:53:19+0000", "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff", "sum_initial": { "amount": 5000000, "currency": "KHR" }, "sum_converted": { "amount": 5000000, "currency": "KHR" }, "code": "0", "message": "Success" }, "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVCyFucJ1a8E9twm5IDxiZ8C2sqcuuncjkbazWKg==" } }
The following is the example of a callback for a declined purchase.
{ "project_id": 1234, "payment": { "id": "1561223423", "type": "purchase", "status": "decline", "date": "2019-07-01T07:54:16+0000", "method": "Cambodia qr", "sum": { "amount": 5000000, "currency": "KHR" }, "description": "1561714332889" }, "customer": { "id": "customer_123" }, "operation": { "id": 39811000003358, "type": "sale", "status": "success", "date": "2019-07-01T07:54:16+0000", "created_date": "2019-07-01T07:53:19+0000", "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff", "sum_initial": { "amount": 5000000, "currency": "KHR" }, "sum_converted": { "amount": 5000000, "currency": "KHR" }, "code": "20000", "message": "General decline" }, "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVb8E9twm5IDxiZ8C2sqcuuncjkbazWKg==" } }
Related topics
The following topics might be useful when implementing payments through Gate:
Analysis of payments results
As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.
You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com
), for instance you can use the analytic panels in the Analytics section for this purpose.
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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
- 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 means of sending requests to the /operations/get endpoint.
If you have any further questions regarding payment data analysis, contact Monetix technical support.