Skip to main content

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 NameData TypeRequiredDescription
1request_idString(100)Unique ID for each Request sent from Baokim to MERCHANT.
2request_timeString(20)Request sent time. Format: YYYY-MM-DD H:i:s
3master_merchant_codeString(50)Unique identifier for MASTER MERCHANT
4sub_merchant_codeString(50)Unique identifier for SUB MERCHANT
5operationString(50)Deposit transaction via VA: DEPOSIT_TRANS
6transactionObjectTransaction information
7va_infoObjectMerchant's deposit VA information

transaction Information

No.Field NameData TypeRequiredDescription
1idNumberBaokim transaction ID
2amountNumberAmount actually received by merchant
3opening_balanceNumberBalance before transaction
4balanceNumberBalance after transaction
5descriptionString(50)Transaction content
6statusNumberTransaction status
7completed_atDateTimeTransaction completion time
8created_atDateTimeTransaction creation time
9updated_atDateTimeTransaction update time

va_info Information

No.Field NameData TypeRequiredDescription
1bank_nameStringVA bank name
2bank_branchStringBranch
3acc_noStringVA account number
4acc_nameStringVA account name
5qr_stringStringQR string
6qr_pathStringQR 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"
}
}