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

Webhook thông báo giao dịch

Quy trình​

Baokim gọi API webhook của MERCHANT để gửi thông báo giao dịch.

Thông tin API​

Method: POST

URL: Merchant cung cấp

Header:

  • Content-Type: application/json
  • Signature: $signature

Request​

(Tham số Baokim gửi lên)

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ừ MERCHANT sang Baokim
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
5store_codeString❌Mã cửa hàng
6branch_codeString❌Mã chi nhánh
7staff_codeString❌Mã nhân viên
8transactionObject✅Thông tin giao dịch
9va_infoObject✅Thông tin VA

Thông tin transaction​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1idInteger✅Mã giao dịch của Baokim
2order_idInteger✅Mã đơn hàng của Baokim
3mrc_order_idString✅Mã đơn hàng merchant
4sub_merchant_feeInteger✅Phí của sub merchant
5master_merchant_feeInteger✅Phí của master merchant
6master_merchant_modelInteger✅Mô hình master merchant
7user_feeInteger✅Phí của user
8total_amountInteger✅Tổng tiền user cần phải thanh toán
9amountInteger✅Số tiền merchant thực nhận
10descriptionString✅Nội dung giao dịch
11statusInteger✅Trạng thái giao dịch
12completed_atDatetime✅Thời gian hoàn thành giao dịch
13created_atDatetime✅Thời gian tạo giao dịch
14updated_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_stringText✅Chuỗi QR
6qr_pathString✅Đường dẫn ảnh QR

Ví dụ resquest​

{
"request_id": "MERCHANT050015588AXE012",
"request_time": "2020-08-11 14:41:00",
"master_merchant_code": "MASTERMERCHANT",
"sub_merchant_code": "SUBMERCHANT",
"store_code": null,
"branch_code": null,
"staff_code": null,
"transaction": {
"id": 5567261,
"order_id": 1870436,
"mrc_order_id": "TT1790305520_VA6AB5E5034028DO",
"sub_merchant_fee": 2200,
"master_merchant_fee": 1100,
"master_merchant_model": 1,
"user_fee": 0,
"total_amount": 200000,
"amount": 200000,
"description": "NGUYEN VAN A chuyen tien",
"status": 1,
"completed_at": "2020-08-11 14:41:00",
"created_at": "2020-08-11 14:41:00",
"updated_at": "2020-08-11 15: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"
}
}

Response​

(Merchant phản hồi lại Baokim)

Bảng tham số chính​

STTTên trườngKiểu dữ liệuBắt buộcMô tả
1codeInteger✅Mã kết quả. 0, 100 hoặc 200 = Thành công
2messageString✅Thông báo kết quả xử lý
3dataObject❌Dữ liệu trả về (nếu có)

Ví dụ Response​

{
"code": 200,
"message": "Successfully",
"data": null
}