📖API VIETQR CALLBACK

通过 VietQR 代码接收余额变动的 API 服务集成测试流程描述.

测试指南

为了配置与 VietQR 的 API 连接，请提供以下信息：

• 商户名称： (希望显示的商店/企业名称)

• 连接 URL： (API 连接地址)

• URL Path (后缀)： (如有扩展路径)

• 连接密钥： (用于数据传输的密钥)

• 用户名： (客户可根据需求自行设置)

• 密码： (客户可根据需求自行设置)

或者，您可以开通 VIETQR 账户，并通过以下链接进行注册和 API 认证：

📌 注册商户

📌 API 服务

文档结构及执行步骤

文档共分为 5 个部分：

1️⃣ 实现 Get Token API

2️⃣ 执行 Transaction Sync API

3️⃣ 调用 Get Token API

4️⃣ 生成 VietQR 代码 API

5️⃣ 测试回调 API

详细执行步骤

📌 第一步：配置 API 连接

客户需要按照以下顺序执行操作：

✅ 步骤 1 → 步骤 2 → 步骤 3 → 步骤 4 → 步骤 5

✅ 完成以上步骤后，进行 API 连接测试。

详细流程

1. 部署 Get Token API

2. 执行 Transaction Sync API

3. 调用 Get Token API

4. 生成 VietQR 代码 API

5. 测试回调 API

📌 第二步：数据检查

🔹 检查已配置的数据 (步骤 1 和 步骤 2)，确保数据准确无误

🔹 如果出现错误，请修正后再继续下一步

⚠️ 注意：完成所有步骤后，客户可以进行完整测试，以确保系统符合业务需求。

📌 测试完成后上线 (GOLIVE)

✅ 测试通过后，系统将正式部署到银行的生产环境

API 文档详细说明

Cán bộ KD	• Mobile:	• Email:
📞 Lê Hương	0968 383 636 024 6663 3324	[e-mail] [e-mail]
📞 Đạo	0923 006 234	[e-mail]
📞 Tạ Quang Tuấn	0966 266 049	[e-mail]
📞 Hoàng Văn Hiển	0565 606 789	[e-mail]
📞 Thịnh Nguyễn	0936 381 333	[e-mail]
📞 Tuấn Phạm	0922 333 636	[e-mail]
📞 Hotline	0939 603 636	[e-mail] [e-mail]

✉️ 邮件支持：[e-mail] / [e-mail]

🔹 如果需要进一步支持，请根据以上信息联系销售部门。

Mô tả chi tiết về tài liệu API

API Get Token

Các bước để nhận biến động số dư từ VietQR

(Áp dụng để đối tác đồng bộ biến động số dư do VietQR trả về)

Bước 1: Cấp quyền truy cập API

• Đối tác cần cấp quyền cho VietQR bằng cách thiết lập quyền truy cập vào API Transaction Sync.

• Cấu hình điểm nhận dữ liệu (Webhook) để VietQR có thể gửi thông tin biến động số dư.

Bước 2: Cấu hình đầu hứng (Webhook)

• Đối tác cung cấp URL endpoint để nhận dữ liệu.

• Đảm bảo endpoint hỗ trợ nhận dữ liệu từ VietQR với phương thức POST.

• Kiểm tra bảo mật, xác thực request từ VietQR.

Bước 3: VietQR gửi dữ liệu biến động số dư

• Khi có giao dịch mới, VietQR sẽ gửi thông tin biến động số dư theo thời gian thực đến webhook của đối tác.

• Dữ liệu bao gồm:

• Số tiền thay đổi

• Số dư mới

• Thời gian giao dịch

• Mã giao dịch

• Các thông tin khác tùy theo cấu hình

Bước 4: Xác nhận và xử lý dữ liệu từ VietQR

• Đối tác nhận request từ VietQR và xác thực dữ liệu.

• Lưu trữ hoặc xử lý thông tin theo nhu cầu (cập nhật vào hệ thống, hiển thị trên ứng dụng, v.v.).

• Trả về response 200 OK để xác nhận đã nhận dữ liệu thành công.

Bước 5: Kiểm tra và giám sát

• Định kỳ kiểm tra logs để đảm bảo không có lỗi kết nối.

• Nếu có lỗi (mất kết nối, dữ liệu sai, v.v.), cần kiểm tra lại cấu hình webhook hoặc liên hệ hỗ trợ từ VietQR.

👉 Lưu ý: VietQR có thể yêu cầu xác thực webhook bằng token hoặc chữ ký số để đảm bảo an toàn khi truyền dữ liệu.

API Transaction Sync

// Some code