Chuyển tới nội dung chính

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​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1master_merchant_codeString(50)✅Mã định danh duy nhất cho master merchant
2sub_merchant_codeString(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​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1codeNumber(3)✅Mã lỗi của Baokim
2messageString(200)✅Thông báo mã lỗi của Baokim
3dataObject✅Dữ liệu Baokim trả về

Thông tin data​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1list_bank_acceptsArray✅Danh sách object Ngân hàng hỗ trợ Deeplink

Thông tin list_bank_accepts​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1bank_noString(6)✅Mã ngân hàng
2nameString(255)✅Tên ngân hàng
3short_nameString(20)✅Tên viết tắt của ngân hàng
4logo_linkString(255)✅Link ảnh logo của ngân hàng
5deeplink_typeInteger✅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
6deeplink_urlString(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ỗiMô tả
200Thành công
101Baokim system error
104Lỗi xác thực OAuth
105Lỗi xác thực chữ ký
422Lỗi validate tham số