Tra cứu Merchant

Quy trình

Mô tả:

• Đối tác gọi API này để tra cứu danh sách merchant (sub merchant) đã đăng ký với Baokim, kèm tài khoản nhận tiền và cửa hàng.
• Kết quả được phân trang.

Thông tin API

Method: POST

URL: {BASE_URL}/ats/merchant

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ả
sub_merchant	String	❌	Lọc theo mã sub merchant
from_date	Datetime	❌	Lọc theo thời gian đăng ký từ. Format: YYYY-MM-DD HH:mm:ss
end_date	Datetime	❌	Lọc theo thời gian đăng ký đế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",
  "sub_merchant": "SHOP123",
  "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. Không có khi lỗi

Thông tin merchant (response.data[])

Tên trường	Kiểu dữ liệu	Mô tả
partner_code	String	Mã đối tác
sub_merchant	String	Mã sub merchant
status	Integer	Trạng thái đăng ký. 1 = đang hoạt động
account_no	String	Số tài khoản nhận tiền của merchant
bank_no	String	Mã ngân hàng của tài khoản nhận tiền
store_code	String	Mã cửa hàng
store_name	String	Tên cửa hàng
acc_holder	String	Tên chủ tài khoản
created_at	Datetime	Thời gian tạo
updated_at	Datetime	Thời gian cập nhật cuối

Thông tin phân trang (response)

Tên trường	Kiểu dữ liệu	Mô tả
current_page	Integer	Trang hiện tại
per_page	Integer	Số bản ghi mỗi trang
total	Integer	Tổng số bản ghi
last_page	Integer	Trang cuối
from	Integer	Thứ tự bản ghi đầu tiên của trang
to	Integer	Thứ tự bản ghi cuối cùng của trang
data	Array	Danh sách bản ghi

Ví dụ Response

{
  "response_code": 200,
  "response_message": "Thành công",
  "response": {
    "current_page": 1,
    "data": [
      {
        "partner_code": "CASHPLUS",
        "sub_merchant": "SHOP123",
        "status": 1,
        "account_no": "0123456789",
        "bank_no": "970436",
        "store_code": "STORE001",
        "store_name": "Cửa hàng 1",
        "acc_holder": "NGUYEN VAN A",
        "created_at": "2025-01-10 09:00:00",
        "updated_at": "2025-01-10 09:00: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)