# 2. Get wallet user information (balance)

# Request URL

  • {domain}/open-api/jt/wallet/balance

# Request Method

  • POST

# Request Headers

Parameter Name Required Type Description
Content-Type Yes string application/json

# Request Body Parameters

Parameter Name Required Type Description
appId Yes string Application APPID
param Yes string Parameter body
sign Yes string Signature

# param Parameters

Parameter Name Required Type Length Example Description
timestamp Yes long - 1677495496979 Millisecond timestamp
mchUuidList No List 5000 - Merchant user UUID (unique identifier)
size No int - - Number of records per page (default: 15, max: 10,000)
page No int - - Page number (default: 1)
KYCStatus No List - - User KYC verification status (Unsubmitted, Pending, Approved, Rejected)
authorizationStatus No List - - User authorization status for deductions (Authorized, Unauthorized)
mobileVerificationStatus No List - - Mobile phone verification status (Verified, Unverified)
userStatus No List - - User account status (Active, Deactivating, Deactivated)

# Request Example

# Request Body

{
  "appId": "733b887a4a784708bb369524db5b6ded",
  "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
  "param": "{\"timestamp\":1715595802,\"mchUuidList\":[\"JT1095595801938341100\",\"JT1095595801938341101\"]}"
}

How to construct request body


# Response Parameters

参数名 类型 说明
code integer response code
message string response message
data Object data

# data Parameters

Parameter Name Type Description
list List Paginated records information, sorted by creation time in descending order
total integer Total number of records
size integer Number of records displayed per page
current integer Current page number
totalBalance long Total wallet balance (in cents, e.g. 500 THB = 50000)
totalBaseBalance long Total regular balance (in cents, e.g. 500 THB = 50000)
totalWithdrawThreshold long Total retention amount/credit limit (in cents, e.g. 500 THB = 50000)

# list Parameters

Parameter Name Type Description
mchUuid string Merchant user's unique UUID identifier
uuid string Wallet user's unique UUID
balance long Wallet balance (in cents, e.g. 500 THB = 50000)
baseBalance long Regular balance (in cents, e.g. 500 THB = 50000)
withdrawThreshold long Retention amount/Credit limit (in cents, e.g. 500 THB = 50000)
createTime string Creation timestamp (format: "YYYY-MM-DD HH:mm:ss", e.g. "2024-11-22 00:00:00")
updateTime string Last update timestamp (format: "YYYY-MM-DD HH:mm:ss", e.g. "2024-11-22 00:00:00")
KYCStatus string User KYC verification status (Unsubmitted, Pending, Approved, Rejected)
authorizationStatus string User deduction authorization status (Authorized, Unauthorized)
mobileVerificationStatus string Mobile phone verification status (Verified, Unverified)
userStatus string User account status (Active, Deactivating, Deactivated)

# Response Example

# Response Data Body

{
  "code": 10000,
  "message": "Success",
  "data": {
    "total": 2,
    "size": 15,
    "current": 1,
    "totalBalance": 0,
    "totalBaseBalance": 0,
    "totalCodBalance": 0,
    "totalUnclearBillAmountDue": 334044,
    "totalUnclearBillAmount": 334044,
    "totalWithdrawThreshold": 159500,
    "list": [
      {
        "mchUuid": "JT1095595801938341100",
        "uuid": "U1095595801938341100",
        "centerNo": "A000001",
        "branchNo": "A000001",
        "balance": 360000,
        "baseBalance": 200000,
        "codBalance": 160000,
        "withdrawThreshold": 20000,
        "unclearBillAmountDue": 50000,
        "unclearBillAmount": 60000,
        "createTime": "2024-11-22 00:00:00",
        "updateTime": "2024-11-22 00:00:00",
        "KYCStatus": "Pending",
        "authorizationStatus": "Authorized",
        "mobileVerificationStatus": "Verified",
        "codEnableStatus": "Enable",
        "userStatus": "Active"
      },
      {
        "mchUuid": "JT1095595801938341101",
        "uuid": "U1095595801938341100",
        "centerNo": "A000001",
        "branchNo": "A000001",
        "balance": 360000,
        "baseBalance": 200000,
        "codBalance": 160000,
        "withdrawThreshold": 20000,
        "unclearBillAmountDue": 50000,
        "unclearBillAmount": 60000,
        "createTime": "2024-11-22 00:00:00",
        "updateTime": "2024-11-22 00:00:00",
        "KYCStatus": "Pending",
        "authorizationStatus": "Authorized",
        "mobileVerificationStatus": "Verified",
        "codEnableStatus": "Enable",
        "userStatus": "Active"
      }
    ]
  }
}

Code Collection

# Failed Response Example

{
  "code": 1002,
  "message": "merchant white ip forbidden"
}