Open API Reference for Bluepay

# 4. Get user balance transaction history

# Request URL

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

# Request Method

  • POST

# Request Headers

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

# Request Body Parameters

参数名 必选 类型 说明
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 - Jitu user UUID unique identifier
balanceRefNoList No List 5000 - Balance transaction reference number
mchOrderIdList No List 5000 - Merchant order number
transactionType No string - - Transaction type (TOP_UP(Top-up), MOBILE_TOP_UP(Mobile top-up), CASH_OUT(Cash withdrawal), MOBILE_TOP_UP_FAILED(Mobile top-up failed), CASH_OUT_FAILED(Cash withdrawal failed), CASH_IN(Receipt), CONSUMPTION(Consumption), TRANSFER_OUT(Transfer out), TRANSFER_IN(Transfer in))
creditDebitType No string - - Revenue/expense type (CREDIT, DEBIT)
startTime Yes string - 2024-11-25 10:00:00 Query start time (maximum query period cannot exceed 31 days)
endTime Yes string - 2024-11-25 15:00:00 Query end time (maximum query period cannot exceed 31 days)
size No int - - Number of items per page (default: 15, maximum: 10,000 per page)
page No int - - Page number (default: 1)

# Request Example

# Request Body

{
  "appId": "733b887a4a784708bb369524db5b6ded",
  "sign": "A5Vd8NcQvU3QT41Yee2jCIK58jDAKZ6kP5gEE4q7Yu92hUCY3k00FKTSlCNU+CcZm0LSrGbEMFMID3p7uvXaqy5khNv3kPndrgp7MIRHUmQnMgRK+g1XG7PzWdnrqlXc3g+L+kqVja+qrFRz+uVS6GLKLR1P4AtgTa9dok6NU7YTWOnG9r/FwIVx/At4czfEpI10pvg2TptVpiANmseGmz4G30hkaYTTNahkcOMQJn6PDFjivHvjNLZNJVOqHQzVUa+kca1yZZMPHtgxR647KjoY2oAjjl0Y45GL6zP9qHD/eVwcPPAPrRZ4K2o05OJnPf67fAcWNVqpnu6ZGQIXhQ==",
  "param": "{\"timestamp\":1715595802,\"mchUuidList\":\"JT1095595801938341100\",\"startTime\":\"2024-11-25 10:00:00\",\"endTime\":\"2024-11-25 15:00:00\"}"
}

How to construct request body

# Response Parameters

Parameter Name Type Description
code integer response code
message string response message
data List 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

# list Parameters

Parameter Name Type Description
mchUuid string Merchant user UUID (unique identifier)
uuid string Wallet user UUID
mchOrderId string Merchant order number
balanceRefNo string Balance transaction reference number
transactionType string Transaction type (TOP_UP(Top-up), MOBILE_TOP_UP(Mobile top-up), CASH_OUT(Cash withdrawal), MOBILE_TOP_UP_FAILED(Mobile top-up failed), CASH_OUT_FAILED(Cash withdrawal failed), CASH_IN(Receipt), CONSUMPTION(Consumption), TRANSFER_OUT(Transfer out), TRANSFER_IN(Transfer in))
creditDebitType string Revenue/expense type (CREDIT, DEBIT)
amount long Transaction amount (positive or negative value)
fee long Fee amount
balance long Updated balance after transaction
createTime string Creation time (format: "YYYY-MM-DD HH:mm:ss", e.g. "2024-11-22 00:00:00")
remark string Remarks/notes
cashoutBank string Withdrawal bank name
cashoutBankAccountName string Withdrawal bank account holder name
cashoutBankAccountNo string Withdrawal bank account number

# Response Example

# Response Data Body

{
  "code": 10000,
  "message": "Success",
  "data": {
    "total": 2,
    "size": 15,
    "current": 1,
    "list": [
      {
        "mchUuid": "JT1095595801938341100",
        "uuid": "U1095595801938341100",
        "mchOrderId": "MCH1095595801938341100",
        "balanceRefNo": "BRF15487954877",
        "transactionType": "CASH_IN",
        "creditDebitType": "CREDIT",
        "amount": 200000,
        "fee": 2000,
        "balance": 5000000,
        "createTime": "2024-11-23 12:12:12",
        "remark": "Test",
        "cashoutBank": "",
        "cashoutBankAccountName": "",
        "cashoutBankAccountNo": ""
      },
      {
        "mchUuid": "JT1095595801938341100",
        "uuid": "U1095595801938341100",
        "balanceRefNo": "BRF15487954877",
        "transactionType": "CASH_OUT",
        "creditDebitType": "DEBIT",
        "amount": -200000,
        "fee": 2000,
        "balance": 4800000,
        "createTime": "2024-11-23 12:12:12",
        "remark": "Test",
        "cashoutBank": "KBANK",
        "cashoutBankAccountName": "T******t",
        "cashoutBankAccountNo": "081******890"
      }
    ]
  }
}

Code Collection

# Failed Response Example

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

←