Table of content
Overview
The VNPAY QR Payment APIs provide seamless integration between NCB and VNPAY for QR-based payment flows. These APIs enable customers to retrieve accepted payment sources, verify bill information after scanning a QR code, synchronize successful payments, and handle failure cases by voiding unsuccessful transactions.
Why use these APIs?
- Payment source selection: Ensures customers can select the correct account or card accepted by merchants before paying.
- Bill verification: Allows customers to review payment details before confirming.
- Payment synchronization: Keeps VNPAY and billers updated once NCB records a payment.
- Error handling: Provides mechanisms to void failed transactions and ensure proper reconciliation.
- Enhanced customer experience: Reduces errors, improves transparency, and streamlines QR-based payment flows.
Key features
- POST /check-source-money
Retrieves the list of payment sources that are accepted by merchants for QR VNPAY transactions. - POST /get-infor-qr-vnpay
Retrieves billing information from VNPAY after scanning a QR code or before recording a payment. - POST /qr-vnpay-pay
Notifies VNPAY after NCB records a payment, allowing VNPAY to process the transaction and, if applicable, sends an order processing request to the merchant so that the order can be processed. - POST /void-qr-vnpay
Notifies VNPAY to void a payment when a failure occurs, except for suspicious cases that require manual review.
