Get bank list

Path

• URL: /api/v1/disbursement/get-bank-list
• Method: POST
• Description: This API allows you to get a list of Vietnam-based banks.

Request

Request table

Params	Data Type	Required	Description
request_id	string(50)	Yes	The only code that corresponds to an upload request. Format: MerchantCode + BK + YYYYMMDD + UniqueId
request_time	string(19)	Yes	Time to send request from merchant, format: YYYY-MM-DD HH:MM:SS
merchant_code	string(20)	Yes	Merchant code provided by Baokim before integration

Request Example

{
  "request_id": "MerchantCodeBK20231106UniqueId",
  "request_time": "2024-11-06 10:15:30",
  "merchant_code": "MerchantCode1234"
}

Response

Response table

Params	Data Type	Description
response_code	int(4)	Error code from Baokim as per Error Codes Table
response_message	string(200)	Description of the error code from Baokim as per Error Codes Table
data	array	List of banks, where each bank contains detailed information as specified below

Data Array Structure (Inside data)

Params	Data Type	Description
bank_no	string(20)	Unique identifier code for the bank
bank_name	string(100)	Full name of the bank in Vietnamese
eng_bank_name	string(100)	Full name of the bank in English
bank_short_name	string(50)	Short or abbreviated name of the bank
supports_card_transfer	int(1)	Indicates if the bank supports transfer via card (true = 1, false = 0)
supports_account_transfer	int(1)	Indicates if the bank supports transfer via account (true = 1, false = 0)

Response Example

{
  "response_code": 200,
  "response_message": "Success",
  "data": [
    {
      "bank_no": "970423",
      "bank_name": "Ngân hàng TMCP Tiên Phong",
      "eng_bank_name": "TIEN PHONG COMMERCIAL JOINT STOCK BANK",
      "bank_short_name": "TPBANK",
      "supports_card_transfer": 1,
      "supports_account_transfer": 1
    },
    {
      "bank_no": "970437",
      "bank_name": "Ngân hàng TMCP Phát Triển Thành Phố Hồ Chí Minh",
      "eng_bank_name": "Ho Chi Minh City Development Joint Stock Commercial Bank",
      "bank_short_name": "HDBANK",
      "supports_card_transfer": 0,
      "supports_account_transfer": 1
    },
    {
      "bank_no": "970422",
      "bank_name": "Ngân hàng TMCP Quân Đội",
      "eng_bank_name": "Military Commercial Joint Stock Bank",
      "bank_short_name": "MBBANK",
      "supports_card_transfer": 1,
      "supports_account_transfer": 0
    }
  ]
}

Error Code

Response Code	Response Message
200	Success
99	Pending
11	Failed
101	System Error
110	Merchant Code Invalid
120	Invalid Signature
422	Validation Error