Query User

Process

Description:

• Partners call this API to query the bank accounts of Users that have been synchronized to Baokim via the Synchronize User Accounts API.
• Results are paginated.

API Information

Method: POST

URL: {BASE_URL}/ats/user

Header: Signature — RSA-SHA1 signature of raw body (see Security).

Request

Main Parameters

Field Name	Data Type	Required	Description
request_id	String	✅	Request ID, unique. Maximum 50 characters, only letters, numbers, _, ., -
request_time	Datetime	✅	Request time. Format: YYYY-MM-DD HH:mm:ss. Must not differ by more than 10 minutes from Baokim time
partner_code	String	✅	Partner code provided by Baokim. Used for signature verification and result filtering
code	String	❌	Filter by user code
user_id	String	❌	Filter by user ID
account_no	String	❌	Filter by account number
from_date	Datetime	❌	Filter by synchronization time from. Format: YYYY-MM-DD HH:mm:ss
end_date	Datetime	❌	Filter by synchronization time to. Format: YYYY-MM-DD HH:mm:ss
page	Integer	❌	Page number. Default 1
per_page	Integer	❌	Records per page, from 1 to 100. Default 15

Request Example

{
  "request_id": "REQ20250115103000",
  "request_time": "2025-01-15 10:30:00",
  "partner_code": "CASHPLUS",
  "code": "USER001",
  "page": 1,
  "per_page": 20
}

Response

note

HTTP 200 - Success

Main Parameters

Field Name	Data Type	Required	Description
response_code	Integer	✅	Response code. 200 = success
response_message	String	✅	Response message
response	Object	❌	Paginated result (structure like Query Merchant). Missing on error

User Information (response.data[])

Field Name	Data Type	Description
partner_code	String	Partner code that synchronized the user
user_id	String	User ID
code	String	User code
account_no	String	Account number for receiving funds
bank_no	String	Bank code
created_at	Datetime	First synchronization time
updated_at	Datetime	Last update time

Response Example

{
  "response_code": 200,
  "response_message": "Success",
  "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

Error Code	Description
200	Success
11	Error during Baokim processing
104	request_id or request_time invalid (wrong format, duplicate request_id, or differs by more than 10 minutes)
105	partner_code invalid
120	Signature invalid
201	Invalid parameter (response_message indicates which field)