ABA QR API

1. Introduction

The ABA QR API is a payment solution that allows businesses to generate dynamic QR codes for customers to scan and pay using ABA KHQR, WeChat Pay, or Alipay.
It enables fast and cashless transactions across multiple digital wallets and banking apps.

Common Use Cases

Cashier Screens & POS

Self-service kiosks

QR on invoices or receipts

The cashier processes the payment by selecting either ABA KHQR, WeChat, or Alipay.

A payment QR code appears on the screen for the customer to scan.

The customer scans and completes the QR payment using ABA Mobile or any KHQR member bank's app, WeChat wallet or Alipay wallet.

Once the payment is processed, your system receives a pushback notification with the payment status.

Your system verifies the payment and confirms the order.

2. Set up your QR display UI

To ensure a smooth payment experience, your platform must include a UI to accommodate QR payment acceptance. This includes:

A screen for customers to choose the payment options you offer (ABA PAY, WeChat or Alipay).

An area to display the generated QR code for payment

A confirmation/success screen after the payment is completed.

You must follow PayWay QR payment display guidelines to ensure proper QR placement.

3. Integration steps

Before you start, make sure you have the following:

PayWay Sandbox Account – Register here to test transactions.

Sandbox Merchant ID & API Key – You will receive these via email after registering for the sandbox.

To integrate QR on Display, follow these steps:

Generate a QR Code (QR Payment API)

Use the QR Payment API to generate a payment QR code and display it where customers can scan and pay.

Upon a successful request, the API will respond with a JSON object containing all necessary information, which you can display in your preferred payment interface.

Sample Response

{
    "amount": "0.01",
    "qr_string": "00020101021230510016aba...campaign USD60",
    "qr_image": "data:image/png;base64,iVBOR...w4bAAAFOk",
    "status": {
        "code": "trx-20201019130949",
        "message": "Success!",
        "tran_id": "trx-20201019130949"
    }
}

Customize KHQR Display (Optional)

For KHQR payment options, you can choose from a selection of QR templates to display on your payment interface via theqr_image_templateparameter.

Note: This does not apply to WeChat Pay or Alipay, which will only respond with template1 by default.

The QR images included with the templates are high-resolution and can be up to 0.5 MB in size, which may cause network issues during download.

If your production environments has internet constraints or if network optimization is needed, we recommend using the QR string to generate the QR code on your end. Use the KHQR frame template as a static frame for display.

Handle Callback URL for payment status updates

Once a payment is made using the QR code, the payment gateway will send a payment notification to your callback_url.

Your callback_url must accept HTTP POST method.

Here is the sample response of pushback notification:

{
    "tran_id": "123456789",
    "apv": 123456,
    "status": "0",
    "merchant_ref_no": "ref0001"
}

tran_id string
Payment transaction ID generated by the payment gateway.
Max. Lenght: 20

apv int
Transaction approval code.
Length: 6

status string
Request status 00

merchant_ref_no string
Your payment link reference number.

Verify Payment Status

In addition to verifying the payment status via callback_url, you must also use the Check transaction API to ensure the payment is successfully marked as PAID and was processed correctly.

1. Introduction#

2. Set up your QR display UI#

3. Integration steps#

Customize KHQR Display (Optional)#

1. Introduction

2. Set up your QR display UI

3. Integration steps

Customize KHQR Display (Optional)