Lấy danh sách Ngân hàng hỗ trợ Deeplink
Quy trình
Vị trí trong luồng nghiệp vụ: Bước định kỳ — MERCHANT gọi API này để cập nhật danh sách ngân hàng hỗ trợ Deeplink, dùng để hiển thị giao diện chọn ngân hàng cho người dùng.
- MERCHANT gửi yêu cầu tới Baokim để lấy danh sách các Ngân hàng hỗ trợ Deeplink.
- Khuyến nghị gọi định kỳ để cập nhật danh sách mới nhất.
Thông tin API
Method: GET
URL: /b2b/core/api/ext/deeplink/banks
Request
Bảng tham số chính
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | master_merchant_code | String(50) | ✅ | Mã định danh duy nhất cho master merchant |
| 2 | sub_merchant_code | String(50) | ✅ | Mã định danh duy nhất cho sub merchant |
Ví dụ Request
GET /b2b/core/api/ext/deeplink/banks?master_merchant_code=MASTER_MERCHANT&sub_merchant_code=SUB_MERCHANT
Response
Bảng tham số chính
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | code | Number(3) | ✅ | Mã lỗi của Baokim |
| 2 | message | String(200) | ✅ | Thông báo mã lỗi của Baokim |
| 3 | data | Object | ✅ | Dữ liệu Baokim trả về |
Thông tin data
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | list_bank_accepts | Array | ✅ | Danh sách object Ngân hàng hỗ trợ Deeplink |
Thông tin list_bank_accepts
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | bank_no | String(6) | ✅ | Mã ngân hàng |
| 2 | name | String(255) | ✅ | Tên ngân hàng |
| 3 | short_name | String(20) | ✅ | Tên viết tắt của ngân hàng |
| 4 | logo_link | String(255) | ✅ | Link ảnh logo của ngân hàng |
| 5 | deeplink_type | Integer | ✅ | Loại deeplink: 1 = Mở App và fill sẵn thông tin giao dịch 2 = Chỉ mở App, không fill thông tin giao dịch |
| 6 | deeplink_url | String(255) | ❌ | Deeplink cố định — chỉ có giá trị khi deeplink_type = 2 |
Ví dụ Response
{
"code": 0,
"message": "Success",
"data": {
"list_bank_accepts": [
{
"bank_no": "970423",
"name": "Ngân hàng TMCP Tiên Phong",
"short_name": "TPBANK",
"logo_link": "https://public-cdn.baokim.vn/statics/img/banks/TPBANK.png",
"deeplink_type": 1,
"deeplink_url": null
},
{
"bank_no": "970437",
"name": "Ngân hàng TMCP Phát Triển Thành Phố Hồ Chí Minh",
"short_name": "HDBANK",
"logo_link": "https://public-cdn.baokim.vn/statics/img/banks/HDBANK.png",
"deeplink_type": 1,
"deeplink_url": null
},
{
"bank_no": "970408",
"name": "Ngân hàng TM TNHH MTV Dầu Khí Toàn Cầu",
"short_name": "GPBANK",
"logo_link": "https://public-cdn.baokim.vn/statics/img/banks/GPBANK.png",
"deeplink_type": 2,
"deeplink_url": "https://payment-page.baokim.vn/deeplink?bank=GPBANK"
}
]
}
}
Bảng mã lỗi
| Mã lỗi | Mô tả |
|---|---|
| 200 | Thành công |
| 101 | Baokim system error |
| 104 | Lỗi xác thực OAuth |
| 105 | Lỗi xác thực chữ ký |
| 422 | Lỗi validate tham số |