Deposit Notification Webhook

Process

• Baokim calls the MERCHANT's webhook API to send deposit transaction notifications

API Information

URL: Provided by Merchant

Method: POST

• Header:

  • Content-Type: Application/json

  • Signature: $signature

Baokim Sends to Partner (Webhook)

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	request_id	String(100)	✅	Unique ID for each Request sent from Baokim to MERCHANT.
2	request_time	String(20)	✅	Request sent time. Format: YYYY-MM-DD H:i:s
3	master_merchant_code	String(50)	✅	Unique identifier for MASTER MERCHANT
4	sub_merchant_code	String(50)	✅	Unique identifier for SUB MERCHANT
5	operation	String(50)	✅	Deposit transaction via VA: DEPOSIT_TRANS
6	transaction	Object	✅	Transaction information
7	va_info	Object	✅	Merchant's deposit VA information

transaction Information

No.	Field Name	Data Type	Required	Description
1	id	Number	✅	Baokim transaction ID
2	amount	Number	✅	Amount actually received by merchant
3	opening_balance	Number	✅	Balance before transaction
4	balance	Number	✅	Balance after transaction
5	description	String(50)	✅	Transaction content
6	status	Number	✅	Transaction status
7	completed_at	DateTime	✅	Transaction completion time
8	created_at	DateTime	✅	Transaction creation time
9	updated_at	DateTime	✅	Transaction update time

va_info Information

No.	Field Name	Data Type	Required	Description
1	bank_name	String	✅	VA bank name
2	bank_branch	String	❌	Branch
3	acc_no	String	✅	VA account number
4	acc_name	String	✅	VA account name
5	qr_string	String	✅	QR string
6	qr_path	String	✅	QR image path

Request Example

{
  "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"
  }
}

Partner Responds to Webhook

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	code	Integer	✅	Result code. 0, 100 or 200 = Success
2	message	String	✅	Processing result message
3	data	Object	❌	Returned data (if any)

Response Example

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