Purchase

When performing a purchase, the customer scans the QR code displayed on the checkout page or in your system (when performing the purchase by using Gate).

Countries and regions Lao People's Democratic Republic
Payment currencies LAK
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 Laos QR Banking payment method:

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

The following figure shows the complete purchase processing flow in the Laos QR Banking payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The checkout page is displayed to the customer.
  4. The customer chooses to make a purchase with the Laos QR Banking payment method.
  5. The checkout page displays the QR code to the customer.
  6. The customer completes the purchase.
  7. The provider service sends the purchase result information to the payment platform.
  8. The payment platform sends a callback with the payment result to your system.
  9. 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 Laos QR Banking payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

ParameterDescription

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

account_customer_name
string
strictly required

Customer's full name.

Example: John Doe

payment_currency
string
strictly required

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

Example: LAK

payment_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: 100,000.00 LAK must be sent as 10000000

force_payment_method
string
optional

Parameter that allows you to enforce the Laos QR Banking payment method for your customer and skip the page with payment method selections.

To enforce the Laos QR Banking payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to banks-laos-qr. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'banks-laos-qr'

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.
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: 'LAK',
		payment_amount: 10000000,
		force_payment_method: 'banks-laos-qr',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Displaying bank icons on the checkout page

In the Laos QR Banking payment method, the payments are performed through specific banks. When making a purchase on the checkout page, the customer first chooses a payment method and then selects the bank.

The Laos QR Banking payment method offers several options to display bank icons on the checkout page:

  • Choosing the bank in two steps First, the customer chooses Laos QR Banking among other payment methods, and then selects the bank from the list. This is the default behavior.
  • Displaying banks alongside other payment methods To display banks as separate buttons on the checkout page alongside the other payment methods, add the payment_methods_options object with the split_banks parameter to the request and set the value of this parameter to true.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"banks_laos_qr": {"split_banks": true}}
    
  • Displaying only banks of the Laos QR Banking payment method For the customer to see only banks available in the Laos QR Banking payment method (without other payment methods), add the force_payment_method parameter to the request and set it to banks-laos-qr.
  • Displaying only specific banks To show the customer only specific banks available in the Laos QR Banking payment method, use the force_payment_method parameter with the banks-laos-qr value in the request, add the payment_methods_options object with the split_banks parameter and set this parameter to true. Next, specify the IDs of the banks to display in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"banks_laos_qr": {"split_banks": true, "banks_id": [140, 141]}}

    Here is an example of the data from a request with preselected banks to open the checkout page with EPayWidget.

    Figure 2. Example of the data from a request to open the checkout page with preselected banks
    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: 'LAK',
            payment_amount: 10000000,
            force_payment_method: 'banks-laos-qr',
            payment_methods_options: '{"banks_laos_qr": {"banks_id": [140, 141]}}',
            signature: 'kUi2x9dKHA5VNU0FY...vySO2RLCv1htT4DqtVUkDJrOcZzUCwX6Re1kpZhkIQg=='
        }
    )
  • Enforcing only one bank If you want the customer to go directly to their bank service to complete the payment (without choosing a payment method and bank on the checkout page), use the force_payment_method parameter with the banks-laos-qr value in the request, add the payment_methods_options object with the split_banks parameter and set the value of this parameter to true. Next, specify the ID of the required bank in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"banks_laos_qr": {"split_banks": true, "banks_id": [140]}}

    Here is an example of the data from a request to open the checkout page with one preselected bank by using EPayWidget.

    Figure 3. Example of the data from a request to open the checkout page with one preselected bank
    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: 'LAK',
            payment_amount: 10000000,
            force_payment_method: 'banks-laos-qr',
            payment_methods_options: '{"banks_laos_qr": {"banks_id": [140]}}',
            signature: 'kUi2x9dKHA5VNU0FY...vySO/RLCv1htT4DqtVUkDJrOcZzUCwX6Rek7pZhkIQg=='
        }
    )

Bank IDs to be passed in the banks_id parameter

Bank IDs that you can pass in the banks_id parameter to display the icons of specific banks on the checkout page are listed in the corresponding section Banks available for purchase.

Callback

In the Laos QR Banking 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.

Figure 4. 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": "Laos qr",
        "sum": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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": 10000000,
            "currency": "LAK"
        },
        "sum_converted": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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.

Figure 5. 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": "Laos qr",
        "sum": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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": 10000000,
            "currency": "LAK"
        },
        "sum_converted": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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 Laos QR Banking payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with a payment QR code to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Laos QR Banking payment method.

Figure 6. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. 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.)
  4. The payment platform generates the data for displaying the payment QR code to the customer and sends the data to your system in the display_data array.
  5. Your system displays the QR code to the customer.
  6. The customer completes the purchase.
  7. The provider service informs the payment platform about the purchase result.
  8. The payment platform sends the callback with the payment result to your system.
  9. 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 Laos QR Banking payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/banks/laos-qr/sale
Full API endpoint specification /v2/payment/banks/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix 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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

bank_id
integer
strictly required

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase.

Example: 60881

customer_name
string
strictly required

Customer's full name.

Example: John Doe

payment
object
strictly required

currency
string
strictly required

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

Example: LAK

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: 100,000.00 LAK must be sent as 10000000

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 Laos QR Banking payment method:

Figure 7. 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",
        "email": "johndoe@example.com"
    },
    "account": {
        "bank_id": 60881,
        "customer_name": "John Doe"
    },
    "payment": {
        "currency": "LAK",
        "amount": 10000000
    }
}

Displaying the payment QR code to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment QR code to the customer.

Use the data from the display_data array to display the QR code to the customer.

Table 3. Description of the display_data array
Element Description
{
    "type": "qr_url",
    "title": "qr_url",
    "data": "https://example.com/qr.jpg?v=1"
}
The data that should be encoded in the QR code.

Example: https://example.com/qr.jpg?v=1

The following is the callback fragment containing display_data array.

"display_data": [
    {
        "type": "qr_url",
        "title": "qr_url",
        "data": "https://example.com/qr.jpg?v=1"
    }
]

Callback

In the Laos QR Banking 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.

Figure 8. 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": "Laos qr",
        "sum": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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": 10000000,
            "currency": "LAK"
        },
        "sum_converted": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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.

Figure 9. 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": "Laos qr",
        "sum": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "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": 10000000,
            "currency": "LAK"
        },
        "sum_converted": {
            "amount": 10000000,
            "currency": "LAK"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Banks available for purchase

Supported banks

In the Laos QR Banking 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 Laos QR Banking payment method.

Table 4. Banks available for purchase
BankID
APB63581
BCEL60881
BIC63571
IB63591
JDB63322
LDB63561
LVB63551

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 Laos QR Banking payment method supports, contact your key account manager at Monetix.