Tra cứu User
Quy trình
Mô tả:
- Đối tác gọi API này để tra cứu các tài khoản nhận tiền của User đã đồng bộ sang Baokim qua API Đồng bộ tài khoản User.
- Kết quả được phân trang.
Thông tin API
Method: POST
URL: {BASE_URL}/ats/user
Header: Signature — chữ ký RSA-SHA1 của raw body (xem Bảo mật).
Request
Bảng tham số chính
| Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| request_id | String | ✅ | ID request, không trùng request trước. Tối đa 50 ký tự, chỉ gồm chữ, số, _, ., - |
| request_time | Datetime | ✅ | Thời gian request. Format: YYYY-MM-DD HH:mm:ss. Lệch không quá 10 phút so với giờ Baokim |
| partner_code | String | ✅ | Mã đối tác Baokim cung cấp. Dùng để xác thực chữ ký và lọc kết quả |
| code | String | ❌ | Lọc theo mã User |
| user_id | String | ❌ | Lọc theo ID User |
| account_no | String | ❌ | Lọc theo số tài khoản |
| from_date | Datetime | ❌ | Lọc theo thời gian đồng bộ từ. Format: YYYY-MM-DD HH:mm:ss |
| end_date | Datetime | ❌ | Lọc theo thời gian đồng bộ đến. Format: YYYY-MM-DD HH:mm:ss |
| page | Integer | ❌ | Số trang. Mặc định 1 |
| per_page | Integer | ❌ | Số bản ghi mỗi trang, từ 1 đến 100. Mặc định 15 |
Ví dụ Request
{
"request_id": "REQ20250115103000",
"request_time": "2025-01-15 10:30:00",
"partner_code": "CASHPLUS",
"code": "USER001",
"page": 1,
"per_page": 20
}
Response
ghi chú
HTTP 200 - Thành công
Bảng tham số chính
| Tên trường | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| response_code | Integer | ✅ | Mã phản hồi. 200 = thành công |
| response_message | String | ✅ | Thông báo |
| response | Object | ❌ | Kết quả phân trang (cấu trúc như Tra cứu Merchant). Không có khi lỗi |
Thông tin User (response.data[])
| Tên trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
| partner_code | String | Mã đối tác đã đồng bộ User |
| user_id | String | ID User |
| code | String | Mã User |
| account_no | String | Số tài khoản nhận tiền |
| bank_no | String | Mã ngân hàng |
| created_at | Datetime | Thời gian đồng bộ lần đầu |
| updated_at | Datetime | Thời gian cập nhật cuối |
Ví dụ Response
{
"response_code": 200,
"response_message": "Thành công",
"response": {
"current_page": 1,
"data": [
{
"partner_code": "CASHPLUS",
"user_id": "100245",
"code": "USER001",
"account_no": "9876543210",
"bank_no": "970416",
"created_at": "2025-01-10 09:00:00",
"updated_at": "2025-01-12 14:20:00"
}
],
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}
Error Codes
| Mã lỗi | Mô tả |
|---|---|
| 200 | Thành công |
| 11 | Lỗi trong quá trình xử lý bên Baokim |
| 104 | request_id hoặc request_time không hợp lệ (sai định dạng, trùng request_id, hoặc lệch quá 10 phút) |
| 105 | partner_code không hợp lệ |
| 120 | Chữ ký không hợp lệ |
| 201 | Tham số không hợp lệ (response_message nêu trường lỗi) |