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

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ườngKiểu dữ liệuBắt buộcMô tả
request_idString✅ID request, không trùng request trước. Tối đa 50 ký tự, chỉ gồm chữ, số, _, ., -
request_timeDatetime✅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_codeString✅Mã đối tác Baokim cung cấp. Dùng để xác thực chữ ký và lọc kết quả
codeString❌Lọc theo mã User
user_idString❌Lọc theo ID User
account_noString❌Lọc theo số tài khoản
from_dateDatetime❌Lọc theo thời gian đồng bộ từ. Format: YYYY-MM-DD HH:mm:ss
end_dateDatetime❌Lọc theo thời gian đồng bộ đến. Format: YYYY-MM-DD HH:mm:ss
pageInteger❌Số trang. Mặc định 1
per_pageInteger❌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ườngKiểu dữ liệuBắt buộcMô tả
response_codeInteger✅Mã phản hồi. 200 = thành công
response_messageString✅Thông báo
responseObject❌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ườngKiểu dữ liệuMô tả
partner_codeStringMã đối tác đã đồng bộ User
user_idStringID User
codeStringMã User
account_noStringSố tài khoản nhận tiền
bank_noStringMã ngân hàng
created_atDatetimeThời gian đồng bộ lần đầu
updated_atDatetimeThờ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ỗiMô tả
200Thành công
11Lỗi trong quá trình xử lý bên Baokim
104request_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)
105partner_code không hợp lệ
120Chữ ký không hợp lệ
201Tham số không hợp lệ (response_message nêu trường lỗi)