Skip to main content

Transaction Details

Process

API Information

Method: POST

URL: /api/merchant-hosted/bank-transfer/detail

Request

(Parameters sent by the partner)

Main Parameters Table

No.Field NameData TypeRequiredDescription
1request_idString(50)Unique request ID. Suggested format: MerchantCode+YYYYMMDDHHIISS+UniqueId
2request_timeString(19)Request sent time. Format: YYYY-MM-DD HH:II:SS
3acc_noString(30)VA account number
4merchant_codeString(30)Merchant code
5start_dateString(19)Transaction filter start time. Default: current time minus 1 day
6end_dateString(19)Transaction filter end time

Request Example

{
"request_id": "BK20250717140001",
"request_time": "2025-07-17 14:00:00",
"acc_no": "41313131131313",
"merchant_code": "PARTNER001"
}

Response

(Parameters returned by Baokim)

Main Parameters Table

No.Field NameData TypeRequiredDescription
1codeString(50)Result code
2messageString(200)Error code message
3dataObjectData returned

data.transaction Information

No.Field NameData TypeRequiredDescription
1idIntegerBaokim transaction code
2order_idIntegerAssociated order ID
3mrc_order_idString(50)Merchant order code
4typeInteger1 = Payment, 2 = Refund
5payment_methodInteger1 = VA
6merchant_feeIntegerMerchant fee
7user_feeIntegerUser fee
8total_amountIntegerTotal transaction amount after fees
9amountIntegerAmount merchant receives
10descriptionStringTransaction description
11statusIntegerStatus: 0 = Initialization, 1 = Success, 2 = Failure, 3 = Pending
12completed_atDatetimeSuccess time
13created_atDatetimeCreation time
14updated_atDatetimeUpdate time

data.va_info Information

No.Field NameData TypeRequiredDescription
1bank_nameString(255)VA bank name
2bank_branchString(255)Bank branch
3acc_noString(50)Account identifier number
4acc_nameString(255)Recipient name
5qr_stringStringQR code as text
6qr_pathStringQR image path

Response Example

{
"code": 0,
"message": "Success",
"data": {
"transactions": {
"id": 555002,
"order_id": 987654322,
"mrc_order_id": "ORDER20250717_002",
"type": 1,
"payment_method": 1,
"merchant_fee": 10000,
"user_fee": 0,
"total_amount": 2000000,
"amount": 1990000,
"description": "Payment via virtual account (VA)",
"status": 1,
"bank_code": "VCB",
"completed_at": "2025-07-17 15:45:00",
"created_at": "2025-07-17 15:43:00",
"updated_at": "2025-07-17 15:45: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": "0123456789012",
"acc_name": "Nguyen Van A",
"qr_string": "00020101021238550010A0000007270123000697040300000000000020386304C3A4",
"qr_path": "https://sandbox.baokim.vn/qr/BK987654322.png"
}
}
}

Error Codes

codemessage
100Success
101System error
102Provider error
104JWT authentication error
105Invalid digital signature
106Order amount is insufficient for refund
107Order cannot be refunded
108Order cannot be cancelled
109Order does not exist
110Merchant order code already exists
422Validation error