Chuyển tới nội dung chính

Kiểm Tra Thông Tin VA

API VA Flow

Đường dẫn

  • URL: /cb-core/api/v1/va/check-info
  • Method: POST
  • Mô tả: API cho phép người dùng gửi yêu cầu kiểm tra thông tin của Virtual Account

Request

Bảng Request

Tham sốKiểu dữ liệu + Độ dàiBắt buộcMô tả
request_idstring(50)Mã ID request duy nhất, định dạng đề xuất: MerchantCode+YYYYMMDDHHMMSS+UniqueId
request_timestring(19)Định dạng: YYYY-MM-DD HH:MM:SS
merchant_codestring(20)Merchant code được cung cấp bởi Baokim trước khi tích hợp
reference_codestring(100)Mã tham chiếu của VA được quản lý trong hệ thống của bạn

Ví dụ Request

{
"request_id": "PARTNER12320231105123000ID01",
"request_time": "2023-11-05 12:30",
"merchant_code": "PARTNER123",
"reference_code": "ORDER12345"
}

Response

Bảng Response

Tham sốKiểu dữ liệu + Độ dàiBắt buộcMô tả
response_codeint(4)Mã lỗi từ Baokim theo Bảng Mã Lỗi
response_messagestring(100)Mô tả mã lỗi từ Baokim theo Bảng Mã Lỗi
merchant_codestring(20)Merchant code được cung cấp bởi Baokim trước khi tích hợp
reference_codestring(100)Mã tham chiếu của VA được quản lý trong hệ thống của bạn
statusint(1)1: Hoạt động; 2: Không hoạt động
expire_datestring(19)Định dạng: YYYY-MM-DD HH:MM:SS
account_infoobjectChi tiết Virtual Account
account_info.bank_namestring(100)Tên ngân hàng
account_info.bank_nostring(6)Mã ngân hàng
account_info.bank_branchstring(100)Chi nhánh ngân hàng
account_info.acc_nostring(22)Số tài khoản ngân hàng
account_info.acc_namestring(63)Tên chủ tài khoản
account_info.qrstring(100)Chuỗi QR được mã hóa base64
account_info.qr_pathstring(100)Đường dẫn hình ảnh QR

Ví dụ Response

{
"response_code": 200,
"response_message": "Success",
"merchant_code": "BAOKIM",
"reference_code": "ORD12345678901234567890345",
"status": 1,
"expire_date": "2024-12-31 23:59",
"account_info": {
"bank_name": "Nguyen Van A",
"bank_no": "963336",
"bank_branch": "Main Branch",
"acc_no": "12345678901234567890",
"acc_name": "John Doe",
"qr": "SGVsbG8sIFdvcmxkIQ==",
"qr_path": "/path/to/qr/image.png"
}
}

Mã Lỗi

Mã ResponseThông báo Response
200Thành công
99Đang xử lý
11Thất bại
101Lỗi Hệ thống
110Merchant Code không hợp lệ
120Signature không hợp lệ
422Lỗi xác thực
1100Virtual Account không tồn tại