Cập nhật trạng thái VCN
⚠️ Tài liệu gốc ghi rõ: hiện tại mới chỉ hỗ trợ khoá thẻ, chưa hỗ trợ mở thẻ — dù bảng tham số liệt kê cả 2 giá trị (1: Mở khoá, 2: Khoá).
Quy trình
Merchant gọi api cập nhật trạng thái VCN khi cần tạm khoá/mở khoá VCN
Thông tin API
URL: /b2b-iccp-service/api/ext/iccp/vcn-update-status/{vcnId}
Method: PUT
Request
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 | ✅ | Id duy nhất ứng với mỗi Request từ MERCHANT sang Baokim. |
| 2 | request_time | String | ✅ | Thời gian gửi Request. Format: YYYY-MM-DD H:i:s |
| 3 | master_merchant_code | String | ✅ | Mã định danh duy nhất cho MASTER MERCHANT |
| 4 | sub_merchant_code | String | ✅ | Mã định danh duy nhất cho SUB MERCHANT |
| 5 | reference_id | String | ✅ | Mã tham chiếu |
| 6 | action | Number | ✅ | Hành động cần update cho VCN - Mở khoá - Khoá Hiện tại mới chỉ hỗ trợ khoá thẻ, chưa hỗ trợ mở thẻ |
Ví dụ Request
{
"request_id": "MERCHANT050015588AXE014",
"request_time": "2025-08-11 14:41:00",
"master_merchant_code": "MASTERMERCHANTCODE",
"sub_merchant_code": "SUBMERCHANTCODE",
"reference_id": "RF_123456789abcxyz",
"action": 2
}
Response
Bảng tham số chính
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | code | Number | ✅ | Mã lỗi của Baokim |
| 2 | message | String | ✅ | Thông báo mã lỗi của Baokim |
| 3 | data | Object | ✅ | Dữ liệu Baokim trả về |
Mô tả dữ liệu bên trong trường data(3)
| STT | Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|---|
| 1 | reference_id | String(50) | ✅ | Mã tham chiếu yêu cầu tạo VCN |
| 2 | vcn_id | Number | ✅ | ID của VCN |
| 3 | status | Number | ✅ | Trạng thái VCN |
Ví dụ Response
{
"code": 100,
"message": "Success",
"data": {
"reference_id": "RF_123456789abcxyz",
"vcn_id": 423677,
"status": 2
}
}
Bảng mã lỗi
| Mã lỗi | Mô tả |
|---|---|
| 100 | Thành công |
| 11 | Thất bại |
| 401 | Merchant verify failed |
| 422 | Lỗi validate |
| 1201 | vcn_id không tồn tại |