Cập Nhật VA
Đường dẫn
- URL:
/api/v1/va/update - Method:
POST - Mô tả: API cho phép cập nhật tài khoản ảo trong hệ thống.
Request
Bảng Request
| Tham số | Kiểu dữ liệu + Độ dài | Bắt buộc | Mô tả |
|---|---|---|---|
| request_id | string(50) | Có | Mã ID request duy nhất, định dạng đề xuất: MerchantCode+YYYYMMDDHHMMSS+UniqueId |
| request_time | string(19) | Có | Thời gian request theo định dạng: YYYY-MM-DD HH:MM:SS |
| merchant_code | string(20) | Có | Nếu Seller nằm dưới sub-merchant của bạn, điền mã sub merchant được cung cấp bởi Baokim. Nếu Seller nằm dưới bạn, điền Merchant_code được cung cấp bởi Baokim ở trên |
| seller_id | string(50) | Không | Mã Seller khớp với Onboarding Sellers API (tùy chọn nếu bạn muốn cập nhật Seller) |
| mid | string(50) | Không | MID trên nền tảng của Seller (tùy chọn, chỉ dành cho các merchant trên nền tảng) |
| reference_code | string(100) | Có | Mã tham chiếu của VA được quản lý trong hệ thống của bạn |
| acc_name | string(63) | Không | Tên cập nhật của chủ tài khoản Virtual Account |
| status | int(1) | Không | Điền 2 nếu bạn muốn hủy kích hoạt VA. Sau khi hủy kích hoạt, VA không thể được cập nhật |
| type | int(1) | Không | 1: Thu đúng số tiền, 2: Thu tự do |
| amount | string(25) | Không | type = 1 => Số tiền bạn muốn thu |
| number_of_times_collect | string(25) | Không | -1: không giới hạn, >= 1 số lần, Nếu bạn không muốn thu nữa, cập nhật status = 2 |
| expire_date | string(19) | Không | Định dạng: YYYY-MM-DD HH:MM:SS |
| memo | string(255) | Không | Ghi chú chuyển khoản cập nhật hoặc mô tả cho Virtual Account |
| va_purpose | int(1) | Không | Mục đích của Virtual Account 1: Ecom Shopee Vietnam 2: Ecom Lazada Vietnam 3: Ecom Tiktokshop Vietnam 4: B2B 5: Website 6: Khác 7: Tất cả |
Ví dụ Request
{
"request_id": "MERCHANT12345678901234510130",
"request_time": "2024-11-15 14:41:00",
"merchant_code": "PHUONGTT",
"seller_id": "SELLER12345",
"mid": "MID12345",
"reference_code": "REF1231081",
"acc_name": "Nguyen Van D",
"type": 1,
"status": 2,
"amount": "20000",
"number_of_times_collect": "2",
"expire_date": "2024-11-20 12:00:00",
"memo": "Payment for order 12345",
"va_purpose": 1
}
Response
Bảng Response
| Tham số | Kiểu dữ liệu + Độ dài | Bắt buộc | Mô tả |
|---|---|---|---|
| response_code | int(4) | Có | Mã lỗi từ Baokim theo Bảng Mã Lỗi |
| response_message | string(100) | Có | Mô tả mã lỗi từ Baokim theo Bảng Mã Lỗi |
| merchant_code | string(20) | Có | Merchant code được cung cấp bởi Baokim trước khi tích hợp |
| reference_code | string(100) | Có | Mã tham chiếu của VA được quản lý trong hệ thống của bạn |
| status | int(1) | Có | 1: Hoạt động, 2: Không hoạt động |
| expire_date | string(19) | Có | Định dạng: YYYY-MM-DD HH:MM:SS |
| account_info | object | Có | Chi tiết Virtual Account |
| account_info.bank_name | string(100) | Có | Tên ngân hàng |
| account_info.bank_no | string(6) | Có | Mã ngân hàng |
| account_info.bank_branch | string(100) | Có | Chi nhánh ngân hàng |
| account_info.acc_no | string(22) | Có | Số tài khoản ngân hàng |
| account_info.acc_name | string(63) | Có | Tên chủ tài khoản |
| account_info.qr | string(100) | Có | Chuỗi QR đư ợc mã hóa base64 |
| account_info.qr_path | string(100) | Có | Đường dẫn hình ảnh QR |
Ví dụ Response
{
"response_code": 200,
"response_message": "Success",
"merchant_code": "PHUONGTT",
"reference_code": "REF1231081",
"status": 1,
"expire_date": "2024-11-20 12:00:00",
"account_info": {
"bank_name": "Ngân hàng Thương mại Cổ phần Đầu tư và Phát triển Việt Nam",
"bank_no": "970418",
"bank_branch": "Hà Nội",
"acc_no": "963336011173760",
"acc_name": "NGUYEN VAN D",
"qr": "00020101021238590010A0000007270129000697041801159633360111737600208QRIBFTTA53037045405200005802VN63049068",
"qr_path": "https://devtest.baokim.vn/vietqr/core/view/BKREF123108120241115144204.jpg"
}
}
Mã Lỗi
| Mã Response | Thông báo Response |
|---|---|
| 200 | Success |
| 99 | Pending |
| 11 | Failed |
| 101 | System Error |
| 110 | Merchant code invalid |
| 120 | Invalid signature |
| 422 | Validation Error |
| 2101 | No VA found with this reference_code |