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.

In-store API

Retail store solutions

Generate face-to-face payment codes at counters to link cashier systems with customer mobile wallets in real time.

View API docs →

Unattended UI

Self kiosk service

Power autonomous ticketing and food ordering terminals with dynamic QR codes and real-time webhook callbacks.

View API docs →

IoT hardware

Parking systems

Integrate boom barriers with timestamp-based fee calculations and hardware relay triggers on payment success.

View API docs →

Micro-transactions

Massage chair nodes

Enable micro-payments with low-latency firmware callbacks that activate mechanical timers on payment confirmation.

View API docs →

Instant dispense

Smart vending slots

Map inventory units to payment intents and trigger product release via slot allocation callbacks on checkout.

View API docs →

App & hardware

Self laundry service

Deploy automated laundromats — scan a hub QR to authenticate and activate a specific washer via digital triggers.

View API docs →

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

{
  "qrString": "000201010212...9",
  "qrImage": "data:image/png;base64, ---REMOVED DATA---",
  "abapay_deeplink": "abamobilebank://ababank.com?...63041A49",
  "app_store": "https://itunes.apple.com/a...0649?mt=8",
  "play_store": "https://play.google.com/...com.paygo24.ibank",
  "amount": 0.01,
  "currency": "USD",
  "status": {
    "code": "0",
    "message": "Success.",
    "trace_id": "65bdc1fde8eea8254a437e51b606b328"
  }
}

Customize QR Image Template (Optional)

The qrImage comes with various options to suit your needs. Please check API document (QR API) on how to customize the qrImage.

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": "5426254593",
"apv": "502809",
"status": "0",
"return_params": "eyJvcmRlcl9pZCI6IjEyMyIsImFtb3VudCI6MTAwLCJjbGllbnRfaWQiOiIxMjM0NTY3ODkwIn0=",
"merchant_ref": ""
}

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 QR Image Template (Optional)#

1. Introduction

2. Set up your QR display UI

3. Integration steps

Customize QR Image Template (Optional)