# API VIETQR CALLBACK

## Hướng dẫn Test Kiểm thử&#x20;

Để cấu hình kết nối API với VietQR, anh/chị vui lòng cung cấp giúp em các thông tin sau : • Tên merchant: (Tên cửa hàng/doanh nghiệp muốn hiển thị)&#x20;

• URL kết nối: (Địa chỉ API để kết nối)&#x20;

• URL Path (Suffix): (Đường dẫn mở rộng nếu có) (Khoá Key kết nối truyền dữ liệu) • Username: (Tự đặt theo nhu cầu của KH)&#x20;

• Password: (Tự đặt theo nhu cầu của KH) Hoặc mở TK VIETQR và ký TK và tự khai báo trong link liên kết :&#x20;

<https://pro.vietqr.vn/merchant-register>

<https://pro.vietqr.vn/api-service/3a4fb799-7cae-47e4-a56d-59d4944313e3>

## Cấu trúc tài liệu và thực hiện gồm 5 phần :

1. Implement Get Token API
2. Execute Transaction Sync API
3. Call Get Token API
4. Generate VietQR Code API
5. Test Callback

### **Hướng dẫn thực hiện từng bước:**

#### Bước 1: Cấu hình và kết nối API

Khách hàng cần thực hiện theo thứ tự sau:

• Bước 1 → Bước 2 → Bước 3 → Bước 4 → Bước 5

• Sau khi hoàn tất các bước trên, bắt đầu test kết nối

**Quy trình cụ thể:**

&#x20;         ✅ Bắt đầu từ Bước 1 (Triển khai API Get Token)

&#x20;         ✅ Sau đó chuyển sang Bước 2 (API Transaction Sync)

&#x20;         ✅ Tiếp tục với Bước 3 (Call API Get Token)

&#x20;         ✅ Sau đó thực hiện Bước 4 (API Generate VietQR Code)

&#x20;         ✅ Cuối cùng là Bước 5 (Gọi API Test Callback)

#### Bước 2: Kiểm tra dữ liệu

• Kiểm tra lại dữ liệu đã cấu hình tại Bước 1 và Bước 2 để đảm bảo tính chính xác.

• Nếu có lỗi, cần chỉnh sửa trước khi tiếp tục các bước tiếp theo.

🔹 Lưu ý: Sau khi hoàn tất các bước trên, khách hàng có thể tiến hành kiểm thử toàn bộ quy trình để đảm bảo hệ thống hoạt động đúng yêu cầu

**Hướng dẫn sau khi hoàn tất GOLIVE kiểm thử**

✅ Sau khi test thành công, khách hàng sẽ được nghiệm thu và triển khai trên môi trường dịch vụ thực của tài khoản ngân hàng.

📌 Liên hệ bộ phận kinh doanh (Khối khách hàng Doanh nghiệp số) để hỗ trợ triển khai:

| Cán bộ KD         | • Mobile:                               | • Email:                                   |
| ----------------- | --------------------------------------- | ------------------------------------------ |
| 📞 Lê Hương       | <p>0968 383 636</p><p>024 6663 3324</p> | <huong.le@vietqr.vn> <huong.le@bluecom.vn> |
| 📞 Đạo            | 0923 006 234                            | <dao.nguyen@bluecom.vn>                    |
| 📞 Tạ Quang Tuấn  | 0966 266 049                            | <tuan.ta@bluecom.vn>                       |
| 📞 Hoàng Văn Hiển | 0565 606 789                            | <hien.hoang@bluecom.vn>                    |
| 📞 Thịnh Nguyễn   | 0936 381 333                            | <thinh@bluecom.vn>                         |
| 📞 Tuấn Phạm      | 0922 333 636                            | <tuan@bluecom.vn>                          |
| 📞 Hotline        | 0939 603 636                            | <sales@vietqr.vn> <sales@bluecom.vn>       |

🔹 Nếu cần thêm hỗ trợ, vui lòng liên hệ với bộ phận kinh doanh theo thông tin trên.

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

{% tabs %}
{% tab title="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.
{% endtab %}

{% tab title="API Transaction Sync" %}

{% endtab %}
{% endtabs %}

```
// Some code
```

<table data-view="cards"><thead><tr><th></th></tr></thead><tbody><tr><td></td></tr></tbody></table>
