Developer Suite
Register Sandbox
Register Sandbox
  1. Plugins
  • Overview
  • API Endpoints
  • Ecommerce Checkout
    • Purchase
      POST
    • Get a transaction details
      POST
    • Close transaction
      POST
    • Check transaction
      POST
    • Refund API
      POST
    • Get transaction list
      POST
    • Exchange rate
      POST
  • Plugins
    • Shopify
    • Prestashop
    • Woocommerce
    • Odoo eCommerce
  • Credentials on File
    • Unschedule Payment
    • Schedule Payment
    • Link Account
      POST
    • Link Card
      POST
    • Payment
      POST
    • Renew Token
      POST
    • Get token details
      POST
    • Remove token
      POST
    • Subscription
      POST
  • ABA QR API
    • QR API
      POST
  • Payment Link
    • Create payment link
      POST
    • Get payment link details
      POST
  • Pre-auth
    • Complete pre-auth transactions
    • Complete pre-auh transaction with payout
    • Cancel pre-purchase transaction
  • Payout
    • Payout
    • Update a beneficiary status
    • Add a beneficiary to whitelist
  • KHQR Guideline
    • Get transactions
  • Resources
  1. Plugins

image.png

1. Introduction#

The ABA PayWay Odoo eCommerce Plugin lets you easily integrate ABA PayWay into your Odoo Website store. This provide a secure online checkout experience while offering multiple popular payment methods, including:
Local: ABA KHQR
International: Card (Visa, Mastercard, UnionPay), WeChat Pay, Alipay

2. How it Works#

image.png
Full Purchase — Payment is charged immediately when the customer completes the payment. Supports all payment methods — ABA KHQR, Card, WeChat Pay, and Alipay.
1.
Shopper adds items to cart and proceeds to checkout.
2.
Shopper selects an ABA PayWay payment method — ABA KHQR, Card, WeChat Pay, or Alipay.
3.
A PayWay-hosted payment popup opens with the correct order amount.
4.
Shopper completes payment inside the secure PayWay popup.
5.
Upon successful payment, the shopper is redirected to a thank you page and the order is automatically marked as Paid.
Authorize then Capture (Card and ABA KHQR only)
Payment is authorized and a hold is placed on the payer's account — no charge until the Merchant successfully fufiles the order.
1.
Shopper adds items to cart and proceeds to checkout.
2.
Shopper selects Card or ABA KHQR as the payment method.
3.
A PayWay-hosted payment popup opens — shopper authorizes the payment.
4.
The amount is reserved on the shopper's account — not yet charged.
5.
Merchant reviews and captures the payment manually from the Odoo backend — full or partial amount.

3. Integration Steps#

3.1 Setup#

Follow the steps below to integrate ABA PayWay into your Odoo Website store.
Prerequisites
Before integrating ABA PayWay into your Odoo eCommerce store, ensure you have the following:
A PayWay Sandbox Account: Register here to receive your testing Merchant ID and API Key via email.
An Odoo 18 instance with the Website module active, hosted on-premise or Odoo.sh. Odoo.com cloud is not supported.
Odoo Admin access — required to install apps and configure payment settings on your Odoo instance.
Step 1: Download and Install the Plugin
1
Download the Plugin
Go to apps.odoo.com and search for ABA PayWay for Odoo eCommerce. Download the module — you will receive one file: payment_aba_payway.zip.
This plugin is built for Odoo 18 and is not compatible with earlier versions.
2
Install the Plugin on Your Server
Using Odoo On-Premise
Unzip the file and copy the extracted folder into your Odoo addons directory on the server.
Configurations:
In /etc/odoo.conf, set addons_path to include the folder containing the ABA PayWay modules:
addons_path = /mnt/extra-addons
If using Docker Compose, mount your addons folder into the container — map your local ./addons to /mnt/extra-addons in the volume config. Then restart the service:
Using Odoo.sh
In Odoo:
Go to Settings › General Settings and activate Developer Mode
Go to Apps › Update Apps List to sync new modules
Search for ABA PayWay for Odoo eCommerce and click Install
ecommerce.png
After install, ABA PayWay appears as a separate entry under Website › Configuration › Payment Providers.
Step 2: Configure the ABA PayWay Plugin
1
Enter Credentials
Go to Website › Configuration › Payment Providers and click on ABA PayWay.
image.png
Enable Test Mode, select the Sandbox environment, and enter your credentials. Your Merchant ID and API Keys are in the email you received after sandbox registration.
image.png
image.png
Configuration Fields
Environment mandatory
Toggle between Sandbox (for testing) and Production (for live payments). Always start in Sandbox mode to ensure payment is tested properly.
Merchant ID (Sandbox/Production) mandatory
Enter your unique ABA PayWay Merchant ID. You can find it in the email registered for your PayWay Sandbox account. When you're ready to go live, replace it with your production Merchant ID.
API Key (Sandbox/Production) mandatory
Enter your ABA PayWay Sandbox API Key for testing. You can find it in the email registered for your PayWay Sandbox account.
RSA Private Key (Sandbox/Production) mandatory
Used for request signing and response verification.
Click Save to store your credentials.
2
Set Capture Mode (optional)
The capture mode controls whether payment is charged immediately or held and captured later. This applies to all transactions on this provider.
Go to Website › Configuration › Payment Providers › ABA PayWay and locate the Capture Mode field.
ModeDescription
Full Purchase (default)Payment is captured immediately when the shopper completes the payment popup
Authorize then CapturePayment is authorized and reserved — merchant captures manually from the backend. Supports Card and ABA KHQR only
image.png
Click Save.
3
Enable Payment Methods
Go to Website › Configuration › Payment Providers › ABA PayWay and locate the Payment Methods section. Enable the methods relevant to your store.
MethodType
ABA KHQRLocal — ABA Mobile and any KHQR-compatible app
Card (Visa, Mastercard, UnionPay)International debit/credit card
WeChat PayInternational — WeChat users
AlipayInternational — Alipay users
For production: only enable payment methods confirmed with the ABA PayWay sales team during onboarding.
image.png
Only the methods enabled here will appear at checkout.

3.2 Testing#

Step 1: Test & Verify the Setup
To confirm a successful setup, preview your Odoo Website store and test the payment flow to ensure everything works as expected.
Verification Checklist:
Go to your store, add a product to the cart, and proceed to checkout.
Verify that the configured ABA PayWay payment methods appear on the payment step:
ABA KHQR
Card (Visa, Mastercard, UnionPay)
WeChat Pay
Alipay
All payment methods are available for testing in sandbox mode.
For live payments, only the options you've agreed upon with the ABA PayWay sales team will be available.
image.png
Step 2: Test Transactions in Sandbox Mode
Full Purchase
Authorize then Capture
Select a payment method at checkout. A loading state appears briefly, then the PayWay payment popup opens with the correct order amount.
Step 2: Test Transactions in Sandbox Mode
Credit/Debit Card
ABA KHQR
WeChat Pay
Alipay
Complete the payment inside the popup. After successful payment:
Shopper is redirected to the thank you page with order number and status
Order is marked as Paid in Odoo
image.png
Step 3: Confirm Order Status
After payment, confirm the response status updates correctly.
✅ Success Status — order is automatically marked as Paid and the shopper is redirected to the thank you page.
image.png
❌ Cancelled / Payment failed — Order stays pending — no charge made.
image.png
Step 4: Verify Transactions
On ABA PayWay Sandbox Portal
You can track transaction details inside the PayWay Sandbox Portal › Transactions — Sign in here.
image.png
On Odoo
Go to Website › Configuration › Payment Transactions to see full transaction details, including status, amount, payment method, and capture mode.
Screenshot 2026-07-14 at 5.25.37 in the afternoon.png
Step 5: Test a Refund
ABA PayWay supports both full and partial refunds for eCommerce orders. Refunds are initiated from the Odoo backend — the plugin calls the ABA PayWay refund API automatically and the refund is reflected in both Odoo and the ABA PayWay Merchant Portal.
Go to Website › Orders, select the paid order and click Refund.
image.png
image.png
image.png
For a full refund — keep the full amount
For a partial refund — enter the amount you'd like to refund your customer
image.png
Click Refund to process. The refund is applied immediately.
The refund is automatically reflected in:
Odoo — order status updates and refund record created
ABA PayWay Merchant Portal — transaction appears under your refund history.
Note: Transaction refunded using the Merchant Portal does not reflect the transaction status on Odoo.

4. Going Live#

Great job! You've completed the sandbox testing, and your store is ready to go live.
Let's make it official! Follow these steps to start accepting real payments:
1
Reach out to ABA PayWay to activate your account
To start accepting real payments, you'll need a production ABA Merchant Account.
If you don't have one yet, please contact our E-Merchant Acquisition team at paywaysales@ababank.com to get started today!
2
Switch to Production Mode
After finalizing your agreement with our team, you'll receive your production credentials.
Go to Website › Configuration › Payment Providers › ABA PayWay.
Replace your Sandbox API Key and Merchant ID with your production credentials
Add your RSA Private Key issued by the ABA PayWay sales team
Switch the Environment toggle to Production
image.png
Click Save to apply your production credentials.
3
Do a Quick Test
Make a small live payment on your store to ensure the transaction settles to your ABA merchant account.
4
Success!
You did it! Your Odoo Website store is officially live and ready to accept real payments with ABA PayWay.
💡 Note
For troubleshooting or if you have any questions, please contact digitalsupport@ababank.com.
Previous
Woocommerce
Next
Credentials on File