Skip to content

Order List

Request URL

methodurl
POST/api/pay/transaction/queryList

Header Information

header parameterdescription
timestampRequest timestamp
nonceRandom value
countryBR
app_codeApp code

Notes

  1. Provides real-time transaction query for the past 90 days. Pull efficiency: A single query takes a natural month (e.g., 00:00:00 on the 1st to 23:59:59 on the 31st) as the interval.
  2. Status coverage logic: For payout business, some country systems may have the possibility of โ€œsuccess first then refundโ€. When processing the data returned by queryList, merchants should treat status == 4 (refund) as the order funds have been reversed. Do not treat it as a new order, but associate it with the original business order for status reconciliation.

Request Parameters

FieldTypeRequiredLengthDescription
pageIndexStringnoCursor: No need to pass for the first page request; must be passed for non-first pages to locate the pagination start position.
pageSizeIntegernoQuery quantity: Default 500, maximum 1000.
typeStringyesBusiness type: PAYIN, PAYOUT, only one type can be queried at a time
statusIntegernoStatus: 1: Processing 2: Success 3: Failed 4: Refund
beginTimeStringyesStart time: Format: yyyy-MM-dd HH:mm:ss.SSS. Constraint: No earlier than 90 days before the current date, no later than the current time
endTimeStringyesEnd time: Format: yyyy-MM-dd HH:mm:ss.SSS. Constraint: endTime - beginTime โ‰ค 31 days
signStringyesSignature
Request
{
"pageIndex": "",
"pageSize": 500,
"type": "PAYIN",
"status": "1",
"beginTime": "2026-03-01 00:00:00.000",
"endTime": "2026-03-01 23:59:59.999",
"sign": "YOUR_SIGN"
}
Cursor
{
"pageIndex": "KgntH8WpwV0lKKYXQr8MY1EgdicDUz/V4l8nCk4QRty3",
"pageSize": 500,
"type": "PAYIN",
"status": "1",
"beginTime": "2026-03-01 00:00:00.000",
"endTime": "2026-03-01 23:59:59.999",
"sign": "YOUR_SIGN"
}

Response Parameters

ParameterTypeRequiredLengthDescription
pageIndexStringyesCursor
recordsListyes
โ€” typeStringyestype: PAYIN PAYOUT
โ€” merchantOrderNoStringyesMerchant order number
โ€” tradeNoStringyesPlatform order number
โ€” amountStringyesOriginal order amount
โ€” transactionAmountStringyesActual transaction amount (excluding fees). 0.00 for failed transactions
โ€” serviceAmountStringyesTotal service fee (fixed fee + percentage fee)
โ€” statusStringyesStatus: 1-Processing, 2-Success, 3-Failed, 4-Refund
โ€” settleStatusStringyesSettlement status: 0-Unsettled, 1-Settled
โ€” createTimeStringyesCreation time โ€” Current country time zone yyyy-MM-dd HH:mm:ss format
โ€” completeTimeStringyesCompletion time โ€” Current country time zone yyyy-MM-dd HH:mm:ss format
โ€” settleTimeStringyesSettlement time โ€” Current country time zone yyyy-MM-dd HH:mm:ss format
โ€” failReasonStringyesError reason
Response
{
"code": 200,
"data": {
"pageIndex": "KgntH8WpwV0lKKYXQr8MY1EgdicDUz/V4l8nCk4QRty3",
"records": [
{
"type": "PAYIN",
"merchantOrderNo": "2C2741241kCApltr2IATMy0c9900440",
"tradeNo": "TS24052200000491357178416",
"amount": "5000.00",
"transactionAmount": "5000.00",
"serviceAmount": "26.00",
"status": 2,
"settleStatus": null,
"failReason": null,
"createTime": "2026-02-27 03:00:47",
"completeTime": "2026-02-27 03:01:08",
"settleTime": null
}
]
},
"msg": "success",
"traceId": "70fc57471a9143e3b7806d473cf33958.90.17727811039671545"
}

Error Codes

Error CodeError MessageHandling Solution
500Business ErrorPlease contact us
600type field invalid parameter valueInvalid parameter value for type field
601Data older than 90 days cannot be queried via API. Please use the portal to export historical reports.Data older than 90 days cannot be queried via API (Please check beginTime field)
602Query range exceeds 31 days. Please query data month by month.Query range exceeds 31 days
603The time cannot be later than the current time.Time cannot be later than current time (Please check beginTime field)
604The start time of the application period cannot be later than the end time.The start time of the application period cannot be later than the end time.
605status field invalid parameter valueInvalid parameter value for status field
606PageIndex parsing failedCursor pagination parsing failed
Error
{
"code": 416,
"data": null,
"msg": "Application not found",
"traceId": "0801113131dd4951a36d19022a31b303.94.17423567008990449"
}