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

Webhook thông báo nạp tiền

Quy trình​

  • Baokim gọi API webhook của MERCHANT để gửi thông báo giao dịch nạp tiền

Thông tin API​

URL: Merchant cung cấp

Method: POST

  • Header:

    • Content-Type: Application/json

    • Signature: $signature

Baokim gửi lên Đối tác (Webhook)​

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1request_idString(100)✅Id duy nhất ứng với mỗi Request từ Baokim gửi sang MERCHANT.
2request_timeString(20)✅Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
3master_merchant_codeString(50)✅Mã định danh duy nhất cho MASTER MERCHANT
4sub_merchant_codeString(50)✅Mã định danh duy nhất cho SUB MERCHANT
5operationString(50)✅GD nạp tiền qua VA: DEPOSIT_TRANS
6transactionObject✅Thông tin giao dịch
7va_infoObject✅Thông tin VA nạp tiền của Merchant

Thông tin transaction​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1idNumber✅Mã giao dịch của Baokim
2amountNumber✅Số tiền merchant thực nhận
3opening_balanceNumber✅Số dư trước giao dịch
4balanceNumber✅Số dư sau giao dịch
5descriptionString(50)✅Nội dung giao dịch
6statusNumber✅Trạng thái giao dịch
7completed_atDateTime✅Thời gian hoàn thành giao dịch
8created_atDateTime✅Thời gian tạo giao dịch
9updated_atDateTime✅Thời gian cập nhật giao dịch

Thông tin va_info​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1bank_nameString✅Tên ngân hàng VA
2bank_branchString❌Chi nhánh
3acc_noString✅Số tài khoản VA
4acc_nameString✅Tên tài khoản VA
5qr_stringString✅Chuỗi QR
6qr_pathString✅Đường dẫn ảnh QR

Ví dụ Request​

{
"request_id": "MERCHANT050015588AXE012",
"request_time": "2026-05-21 14:41:00",
"master_merchant_code": "MASTERMERCHANTCODE",
"sub_merchant_code": "SUBMERCHANTCODE",
"operation": "DEPOSIT_TRANS",
"transaction": {
"id": 5567261,
"amount": 200000,
"opening_balance": 100000,
"balance": 300000,
"description": "NGUYEN VAN A chuyen tien",
"status": 1,
"completed_at": "2026-05-21 14:41:00",
"created_at": "2026-05-21 14:41:00",
"updated_at": "2026-05-21 14:41:00"
},
"va_info": {
"bank_name": "Ngân hàng TMCP Ngoại Thương Việt Nam (Vietcombank)",
"bank_branch": "Chi nhánh Hà Nội",
"acc_no": "01234567890123",
"acc_name": "BAOKIM NGUYEN VAN A",
"qr_string": "00020101021238550010A0000007270123000697040300000000000020386304C3A4",
"qr_path": "https://sandbox.baokim.vn/qr/BK1234567890.png"
}
}

Đối tác phản hồi Webhook​

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1codeString(4)✅code trả về cho phía Baokim, bảo đảm phía MERCHANT đã nhận được
2messageString(20)✅Message trả về cho phía Baokim
3dataObject❌Dữ liệu Merchant trả về cho Baokim nếu có

Ví dụ Response​

{
"code": 100,
"message": "Success",
"data": null
}