Get List of Banks Supporting Deeplink

Process

Position in business flow: Periodic step — MERCHANT calls this API to update the list of banks supporting Deeplink, used to display the bank selection interface to the user.

• MERCHANT sends a request to Baokim to get the list of banks supporting Deeplink.
• Recommended to call periodically to keep the list up to date.

API Information

Method: GET

URL: /b2b/core/api/ext/deeplink/banks

Request

Main Parameters

No.	Field Name	Data Type	Required	Description
1	master_merchant_code	String(50)	✅	Unique identifier for master merchant
2	sub_merchant_code	String(50)	✅	Unique identifier for sub merchant

Request Example

GET /b2b/core/api/ext/deeplink/banks?master_merchant_code=MASTER_MERCHANT&sub_merchant_code=SUB_MERCHANT

Response

Main Parameters

No.	Field Name	Data Type	Required	Description
1	code	Number(3)	✅	Baokim error code
2	message	String(200)	✅	Baokim error message
3	data	Object	✅	Data returned by Baokim

Data Information

No.	Field Name	Data Type	Required	Description
1	list_bank_accepts	Array	✅	List of bank objects supporting Deeplink

list_bank_accepts Information

No.	Field Name	Data Type	Required	Description
1	bank_no	String(6)	✅	Bank code
2	name	String(255)	✅	Bank name
3	short_name	String(20)	✅	Bank short name
4	logo_link	String(255)	✅	Bank logo image link
5	deeplink_type	Integer	✅	Deeplink type: 1 = Opens the app with transaction details pre-filled 2 = Opens the app only, without pre-filled transaction details
6	deeplink_url	String(255)	❌	Fixed deeplink — only present when deeplink_type = 2

Response Example

{
  "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"
      }
    ]
  }
}

Error Codes

Error Code	Description
200	Success
101	Baokim system error
104	OAuth authentication error
105	Signature verification error
422	Parameter validation error