Bỏ qua để đến nội dung chính
Phiên bản: 1.2.2 (Latest)

Truy vấn thông tin người hưởng (BIDV, BaoKim)

GET
URLhttps://open-api.tingee.vn/v1/direct-link/financial-utility/account-inquiry

Truy vấn thông tin tài khoản hưởng

Header Request​

HeaderBắt buộcMô tả
Content-Type✓application/json
x-client-id✓Mã định danh của đối tác do TINGEE cung cấp.
x-signature✓Chữ ký xác thực HMAC SHA512.
x-request-timestamp✓Thời gian gửi request (format: yyyyMMddHHmmssSSS, múi giờ UTC+7)

Query Parameters​

TrườngKiểuBắt buộcMô tả
bankBinstring✓Mã BIN ngân hàng thực hiện truy vấn. Truyền 970418 (BIDV), 970415 (VietinBank) hoặc BAOKIM (BaoKim).
creditAccountNumberstring✓Số tài khoản / số thẻ / số ví người hưởng cần truy vấn.
creditBankBinstring~Mã BIN ngân hàng của người hưởng. Xem tại Danh sách ngân hàng hỗ trợ.
Bắt buộc, trừ trường hợp BAOKIM với accountType = WALLET.
creditBankBranchCodestring✕Mã chi nhánh ngân hàng của người hưởng.
Chỉ áp dụng với VietinBank.
rolestring~Vai trò người dùng: Maker hoặc Checker.
Bắt buộc với BIDV.
accountTypestring~Loại tài khoản người hưởng (chỉ áp dụng với BAOKIM):
- ACCOUNT: Số tài khoản ngân hàng
- CARD: Số thẻ
- WALLET: Ví BaoKim (không cần creditBankBin)
Giá trị ID, PHONE cũng được chấp nhận và xử lý như ACCOUNT.
Bắt buộc với BAOKIM.
walletIdstring~Tên đăng nhập (username) ví BaoKim của doanh nghiệp đã liên kết với TINGEE (ví dùng để tra cứu).
Bắt buộc với BAOKIM.

Ví dụ mã nguồn​

curl --location --request GET 'https://open-api.tingee.vn/v1/direct-link/financial-utility/account-inquiry?bankBin=970418&role=Maker&creditBankBin=970418&creditAccountNumber=1234567890' \
--header 'accept: application/json' \
--header 'x-client-id: YOUR_CLIENT_ID' \
--header 'x-request-timestamp: 20240509154004003' \
--header 'x-signature: YOUR_SIGNATURE'

Response mẫu​

{
"code": "00",
"message": "Success",
"data": {
"creditAccountNumber": "1234567890",
"creditAccountName": "NGUYEN VAN A",
"creditBankBin": "970418"
}
}
TrườngKiểuMô tả
codestringMã kết quả (00 = Thành công).
messagestringThông điệp phản hồi.
dataobjectThông tin người hưởng.
Riêng BAOKIM: nếu BaoKim trả về nhiều kết quả, data là mảng các đối tượng có cùng cấu trúc bên dưới.
data.creditAccountNumberstringSố tài khoản / số thẻ / số ví người hưởng.
data.creditAccountNamestringTên chủ tài khoản người hưởng.
data.creditBankBinstringMã BIN ngân hàng người hưởng.
data.creditPhoneNumberstringSố điện thoại người hưởng (chỉ BAOKIM, nếu có; đã chuyển về dạng 0xxxxxxxxx).

Mã lỗi thường gặp​

CodeMô tảHướng xử lý
1077Phiên ủy quyền BIDV của vai trò (role) đã hết hạn hoặc chưa được cấpGọi Lấy đường dẫn xác thực với đúng role để ủy quyền lại, sau đó tra cứu lại.
1086Ví BAOKIM của Merchant chưa được cấu hìnhKiểm tra walletId đã liên kết với TINGEE; nếu vẫn lỗi, liên hệ TINGEE để hoàn tất cấu hình ví.
1021Ngân hàng không được hỗ trợ cho API nàyKiểm tra bankBin; chỉ hỗ trợ BIDV, VietinBank, OCB và BAOKIM.
90, 91, 92, 97Lỗi xác thực request (timestamp, client-id, chữ ký)Xem Mã lỗi hệ thống.
OthersLỗi khácXem Danh sách mã lỗi.