Tra cứu số dư

⚠️ API này dùng method GET nhưng tài liệu gốc mô tả tham số theo dạng request body (request_id, balance_type...) — theo quy ước chung tại trang Bảo mật, method GET cần ký trên query string đã sort alphabet, không phải JSON body. Cần xác nhận lại với dev cách truyền tham số thực tế cho API này.

Quy trình

Merchant gọi api này để tra cứu số dư của Merchant tại thời điểm gọi.

Thông tin API

URL: /b2b/core/api/ext/balance/inquery

Method: GET

Request

Bảng tham số chính

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	request_id	String	✅	Id duy nhất ứng với mỗi Request từ MERCHANT sang Baokim.
2	request_time	String	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
3	master_merchant_code	String	✅	Mã định danh duy nhất cho MASTER MERCHANT
4	sub_merchant_code	String	✅	Mã định danh duy nhất cho SUB MERCHANT
5	balance_type	Number	✅	1: Số dư tạm tính 2: Số dư chi (ghi nợ)

Ví dụ Request

{
    "request_id": "MERCHANT050015588AXE014",
    "request_time": "2025-08-11 14:41:00",
    "master_merchant_code": "MERCHANTCODE_MASTER",
    "sub_merchant_code": "MERCHANTCODE_SUB",
    "balance_type": 2
}

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	✅	Mã lỗi của Baokim
2	message	String	✅	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	master_merchant_code	String	✅	Mã định danh duy nhất cho MASTER MERCHANT
2	sub_merchant_code	String	✅	Mã định danh duy nhất cho SUB MERCHANT
3	balance	Number	✅	Số dư
4	created_at	DateTime	✅	Ngày tạo
5	updated_at	DateTime	✅	Ngày cập nhật

Ví dụ Response

{
    "code": 100,
    "message": "Success",
    "data": {
        "master_merchant_code": "MERCHANTCODE_MASTER",
        "sub_merchant_code": "MERCHANTCODE_SUB",
        "balance": 100000000,
        "created_at": "2025-12-01 12:00:00",
        "updated_at": "2025-12-01 12:00:00"
    }
}

Bảng mã lỗi

Mã lỗi	Mô tả
100	Thành công
11	Thất bại
401	Merchant verify failed
422	Lỗi validate