API Business Process Description

VietQR API Business Process Description (Mô tả luồng Nghiệp vụ kết nối API VietQR Callback )

VietQR API Business Process Description

1. Steps to Generate a VietQR Payment Code:

• Step 1: Obtain an Access Token

The customer (KH) needs to call the Get Token API from VietQR to access and authenticate. After successful authentication, VietQR will return a token, which serves as a key to access the API for generating a VietQR payment code.

🔗 Reference: API Get Token

• Step 2: Generate a VietQR Payment Code

After receiving the token, the customer uses it to call the API for generating a VietQR payment code.

🔗 Reference: API Generate VietQR Code

• Step 3: Simulate Payment in Test/Staging/Sandbox Environments

In a testing environment, the customer does not need to scan the QR code for actual payment. Instead, they can call the Test Callback API to simulate a successful transaction.

🔗 Reference: API Test Callback

📌 Note: After completing the payment, the customer needs a system to receive Balance Change Notifications (BĐSD). Therefore, a data reception system must be set up to store and manage transaction information.

2. Setting Up a Data Reception System for Transaction/BĐSD Information

• Step 1: Provide an API Get Token

The customer needs to deploy a Get Token API on their system for authentication and token generation. This token allows VietQR to access the customer’s reception system to push payment/BĐSD data.

🔗 Reference: API Get Token

• Step 2: Create a Transaction Data Reception API

The customer must deploy the Transaction Sync API as the endpoint to receive payment/BĐSD data sent from VietQR.

🔗 Reference: API Transaction Sync

📌 Summary:

The process includes generating a VietQR payment code, simulating payment in a test environment, and building a system to receive transaction/BĐSD data, ensuring all transaction details are fully recorded and managed.