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

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	request_id	String(100)	✅	ID duy nhất ứng với mỗi Request từ MERCHANT sang Baokim
2	request_time	String(20)	✅	Thời gian gửi Request. Format: YYYY-MM-DD H:i:s
3	master_merchant_code	String(50)	✅	Mã định danh duy nhất cho MASTER MERCHANT
4	sub_merchant_code	String(50)	✅	Mã định danh duy nhất cho SUB MERCHANT
5	store_code	String	❌	Mã cửa hàng
6	branch_code	String	❌	Mã chi nhánh
7	staff_code	String	❌	Mã nhân viên
8	transaction	Object	✅	Thông tin giao dịch
9	va_info	Object	✅	Thông tin VA

Thông tin transaction

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	id	Integer	✅	Mã giao dịch của Baokim
2	order_id	Integer	✅	Mã đơn hàng của Baokim
3	mrc_order_id	String	✅	Mã đơn hàng merchant
4	sub_merchant_fee	Integer	✅	Phí của sub merchant
5	master_merchant_fee	Integer	✅	Phí của master merchant
6	master_merchant_model	Integer	✅	Mô hình master merchant
7	user_fee	Integer	✅	Phí của user
8	total_amount	Integer	✅	Tổng tiền user cần phải thanh toán
9	amount	Integer	✅	Số tiền merchant thực nhận
10	description	String	✅	Nội dung giao dịch
11	status	Integer	✅	Trạng thái giao dịch
12	completed_at	Datetime	✅	Thời gian hoàn thành giao dịch
13	created_at	Datetime	✅	Thời gian tạo giao dịch
14	updated_at	Datetime	✅	Thời gian cập nhật giao dịch

Thông tin va_info

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	bank_name	String	✅	Tên ngân hàng VA
2	bank_branch	String	❌	Chi nhánh
3	acc_no	String	✅	Số tài khoản VA
4	acc_name	String	✅	Tên tài khoản VA
5	qr_string	Text	✅	Chuỗi QR
6	qr_path	String	✅	Đườ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,
    "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

(Tham số Đối tác trả về cho Baokim)

Bảng tham số chính

STT	Tên trường	Kiểu dữ liệu	Bắt buộc	Mô tả
1	code	String(3)	✅	code trả về cho phía Baokim, bảo đảm phía MERCHANT đã nhận được
2	message	String(20)	✅	Message trả về cho phía Baokim
3	data	Object	❌	Dữ liệu Merchant trả về cho Baokim nếu có

Ví dụ response

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

Error Codes

Mã lỗi	Mô tả
100	Thành công
11	Thất bại
101	Lỗi hệ thống Baokim
103	Lỗi xác thực chữ ký
104	Lỗi xác thực JWT
422	Dữ liệu không hợp lệ
710	Sub merchant không tồn tại
711	Master merchant không tồn tại
712	Sub merchant đang không hoạt động
713	Master merchant đang không hoạt động