Overview
Introduction
VietQR.vn provides electronic payment services through QR codes, enabling quick, safe, and convenient transactions. VietQR.vn offers customized payment solutions for businesses and supports API integration, aiming to promote the growth of the digital economy in Vietnam.
Integration Process
Basic Steps for Integrating with VietQR:
Partners need to complete the account registration process with full information for account identification and security. The default integration information will be in the Test (Sandbox) environment.
Register a VietQR account.
Link your bank account. (Reference)
Create a service connection request:
Partner implements two APIs: Get Token and Transaction Sync. (Reference)
Notify VietQR's technical team to check for errors and approve the connection request.
VietQR provides a
username
andpassword
for the partner to call VietQR's APIs in the TEST environment.Pass the provided
username
andpassword
into the Get Token API.Call the Generate VietQR Code API to create a payment code.
Call the Test Callback API to simulate a successful payment.
After testing is completed, VietQR will re-verify the partner's integration information on the production environment.
Update the partner's integration information.
Deploy the payment service for the partner.
Note:
The error where the bank account cannot be linked is usually due to entering the wrong phone number or the Citizen ID/Tax Code/Business Registration Certificate not matching the bank account information provided by the partner.
In case the partner encounters an error when calling the Test Callback API, please check if the Transaction Sync API implemented by the partner is in the correct format.
Our Platforms
Types of VietQR Payment Codes
Static VietQR Code
Semi-dynamic VietQR Code
Dynamic VietQR Code
Payment Integration Methods
QR Box: For stores and restaurants. Place a device that generates QR codes for customers to scan and pay.
Plugin: For online shopping websites. Install an additional plugin for the website to accept QR code payments.
API Service: For software systems. Provides tools for software to utilize QR code payments.
Ecommerce: For online stores. Integrate QR codes for customers to shop and pay online.
Platform: For businesses. Supports QR code payments within work and financial management systems.
Vending Machine: For vending machines. Machines accept QR code payments, allowing customers to scan and purchase items.
Balance Fluctuation Sharing Service Packages
Package | Description |
---|---|
VietQR Plus |
|
VietQR Pro |
|
Integration Environments
Testing Environment: Used during the integration process, such as for checking the balance fluctuation reception.
Production Environment: Used for deploying the service for end-users to perform payment transactions.
Security Keys
Access Key: Grants access to call the Get Token API.
Basic Authen: An encrypted string provided by VietQR to the partner.
Check Sum: An MD5 encrypted string used to access certain APIs.
Secret Key: Used to create electronic signatures.
HTTP Request Configuration
Key | Value |
---|---|
Content-Type | application/json; charset=UTF-8 |
Method | POST |
Domain
Environment | Domain |
---|---|
Sandbox | |
Production |
Security
A Secret Key is a character string generated by a specific algorithm used to verify the accuracy of data during transmission between two systems. Some commonly used algorithms include:
MD5: Message Digest Algorithm 5
SHA1: Secure Hash Algorithm 1
SHA256: Secure Hash Algorithm 256
HMAC: Hash-based Message Authentication Code
Last updated