Developer Suite
Register Sandbox
Register Sandbox
    • Overview
    • 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
    • Checkout Plugins
      • Prestashop
      • Woocommerce
    • Credentials on File
      • Link Account
        POST
      • Link Card
        POST
      • Purchase using token
        POST
      • Remove account token
        POST
      • Remove card token
        POST
      • Get linked account details
        POST
    • ABA QR API
      • QR API
        POST
    • Payment Link
      • Create payment link
        POST
      • Get payment link details
        POST
    • Pre-auth
      • Complete pre-auth transactions
        POST
      • Complete pre-auh transaction with payout
        POST
      • Cancel pre-purchase transaction
        POST
    • Payout
      • Payout
        POST
      • Update a beneficiary status
        POST
      • Add a beneficiary to whitelist
        POST
    • KHQR Guideline
    • Resources

    Ecommerce Checkout

    1. Introduction#

    With PayWay eCommerce Checkout, you can easily accept payments on your website or mobile app. This solution lets your customers pay quickly and securely using Credit/Debit Cards, ABA Pay & KHQR (via ABA Mobile or other KHQR-supported banking apps), WeChat Pay or Alipay — to give them a seamless and secure checkout experience.
    Common Use Cases
    Online shopping – Accept payments for products and services.
    Wallet top-ups & digital services – Let users add funds or pay for digital services.
    Subscriptions & bills – As a checkout to process recurring payments and utility bills.
    On-demand services – Handle payments for food delivery, ride-hailing, and more.
    Event bookings – Enable seamless ticket and reservation payments

    2. How it works#

    1.
    The customer selects a product or service and clicks "Pay".
    2.
    They choose a payment method, and a checkout modal appears.
    3.
    The customer completes payment with their chosen method (credit/debit cards, ABA Pay, KHQR, WeChat Pay, Alipay, or Google Pay).
    4.
    Once the payment is processed, your system receives a pushback notification with the payment status.
    5.
    Your system verifies the payment and confirms the order.
    Selling on an eCommerce platform? See our eCommerce Checkout Plugins instead!

    3. Set up your payment selection UI#

    To ensure a smooth payment experience, your platform must include UI to accommodate the online payment acceptance. This includes:
    A section where customers can choose a payment options they want to pay with.
    A "We Accept..." area that shows the payment options you offer.
    You must follows PayWay eCommerce checkout guidelines to ensure seamless customer payments.
    Web UI Guidelines
    To accept payments on your website
    Mobile UI Guidelines
    To accept payments on your app or web app

    4. 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’ll receive these via email after registering for the sandbox.
    To integrate online payments on your website or mobile app, follow these steps:
    1
    Create a Payment Transaction
    When the customer selects "Pay" and chooses a payment method, call the Create Transaction API to generate a transaction and display it on your platform.
    PayWay will respond with a HTML response that contains the checkout interface, which you must render on your website/platform for the customer to complete the payment.
    Web
    WAP/Mobile
    Sample Response (Varies Based on Payment Method):
    Payment method responses
    2
    Handle Callback URL for payment status updates
    Once the customer completes the payment, the details of the transaction and other important information will be sent via return_url URL.
    This is an optional field. If left empty, it will default to the merchant profile’s return_url.
    If you provide a value, ensure that your domain is whitelisted in your merchant profile.
    Your return_url must accept HTTP POST method and Content-Type as application/json.

    💡

    We highly recommend securing this URL to ensure that only PayWay has access to it.

    Sample Pushback Data
    {
    "tran_id": "17425401324",
    "apv": "619195",
    "status": "0", 
    "return_params": "xxxxxxxxxx"
}
    tran_id string
    Transaction ID sent during the initial payment process.
    apv string
    Transaction approval code.
    status string
    Payment status
    return_params string
    Extra information sent to the payment gateway during the payment initiation request.
    3
    Verify Payment Status
    In addition to verifying the payment status via callback URL, you must also use the Check transaction API to verify payment status as PAID and ensure it was successfully processed.
    Previous
    Overview
    Next
    Purchase