Transfer Batch Query
API Information
- Path:
/api/v1/txn/queryList - Method: POST
- Content-Type: application/json
Business Description
- Query transactions by individual or multiple payment transaction IDs or business transaction IDs, with paginated results.
- Provide at least one transaction identifier condition or a complete creation/payment time range.
- All supplied conditions are combined using AND. Only authorized transactions matching every condition are returned.
Request Parameters
Headers
Request Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| Content-Type | application/json | Yes | Request body type |
Request Body
Main Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| merchantNo | string | The merchant number of the request initiator. | M |
| onBehalfOf | string | The merchant number that the request is actually associated with. Provide this field only when initiating a request on behalf of another merchant. | N |
| requestId | string(64) | Single business transaction ID; an empty string is treated as omitted | C |
| payoutId | integer(int64) | Single payment transaction ID | C |
| payoutIds | string(6400) | JSON-encoded string containing an array of payment transaction IDs, e.g. "[\"1965301538608513024\",\"1965301538608513025\"]"; up to 100 original elements | C |
| requestIds | string(6400) | JSON-encoded string containing an array of business transaction IDs, e.g. "[\"ORDER-001\",\"ORDER-002\"]"; up to 100 original elements, each at most 64 characters | C |
| payoutStatus | string | Payment Status/Status enum values | C |
| payoutStartTime | string | Payment Time - Start | C |
| payoutEndTime | string | Payment Time - End | C |
| createTimeStartTime | string | Creation time start; provide together with the end time | C |
| createTimeEndTime | string | Creation time end; provide together with the start time | C |
| payoutMethod | string | Payment Method | C |
| size | integer | Records per page, 1–100; defaults to 10 when omitted or null | N |
| current | integer | Page number, at least 1; defaults to 1 when omitted or null | N |
| sign | string | Signature | M |
Request Example
json
{
"merchantNo": "801040",
"requestId": "",
"payoutId": "1954374604177408000",
"payoutStatus": "",
"payoutStartTime": "",
"payoutEndTime": "",
"createTimeStartTime": "",
"createTimeEndTime": "",
"payoutMethod": "",
"size": "10",
"current": "1",
"sign": "d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842988f2"
}json
{
"merchantNo": "801129",
"payoutIds": "[\"1965301538608513024\",\"1965301538608513025\"]",
"size": 100,
"current": 1,
"sign": "<signature calculated for this request>"
}json
{
"merchantNo": "801129",
"requestIds": "[\"ORDER-001\",\"ORDER-002\"]",
"size": 10,
"current": 1,
"sign": "<signature calculated for this request>"
}Response Result
Response Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | Yes | Response body type |
Response Parameters
Response Fields
| Parameter | Type | Description |
|---|---|---|
| respCode | string | Response Code |
| respMsg | string | Response Message |
| data | object | Response Data |
| └─data | object | Page data |
| └─records | array | Transaction records for the current page |
| └─payoutId | integer | Payment transaction ID |
| └─settleCurrency | string | Settlement currency |
| └─settleSumAmount | number | Actual total settlement amount; settleSumAmount = settleAmount + serviceFee |
| └─serviceFee | number | Service fee |
| └─settleAmount | number | Settlement amount |
| └─payoutCurrency | string | Payout currency |
| └─payoutAmount | number | Payout amount |
| └─convRate | number | Conversion FX rate |
| └─merchantNo | string | Merchant number |
| └─onBehalfOf | string | Merchant number that the request is actually associated with; may be null when not querying on behalf of another merchant |
| └─payeeName | string | Payee name |
| └─payoutStatus | string | Payment status |
| └─payoutTime | string | Payout time |
| └─distributePs | string | Payment reference |
| └─transactionPurpose | string | Transaction purpose |
| └─payoutMethod | string | Payment method |
| └─createTime | string | Creation time |
| └─updateTime | string | Update time |
| └─requestId | string | Business transaction ID |
| └─payoutStatusReason | string | Payment status reason |
| └─total | integer | Total records |
| └─size | integer | Page size |
| └─current | integer | Current page number |
| └─pages | integer | Total pages |
Response Example
json
{
"respCode": "20000",
"respMsg": null,
"data": {
"data": {
"records": [
{
"payoutId": "2100862326273609728",
"settleCurrency": "USD",
"settleSumAmount": 17.170000,
"serviceFee": -5.170000,
"settleAmount": 12.000000,
"payoutCurrency": "USD",
"payoutAmount": 12.000000,
"convRate": 1.000000,
"merchantNo": "800527",
"onBehalfOf": null,
"payeeName": "yuyu liu",
"payoutStatus": "S",
"payoutTime": "2026-09-18 17:10:09",
"distributePs": "REFERENCE BANK",
"transactionPurpose": "5",
"payoutMethod": "BANK_TRANSFER",
"createTime": "2026-09-18 16:19:45",
"updateTime": "2026-09-18 17:10:09",
"requestId": "DM2026081200010",
"payoutStatusReason": ""
},
{
"payoutId": "2100771357805121536",
"settleCurrency": "USD",
"settleSumAmount": 11.120000,
"serviceFee": -5.110000,
"settleAmount": 6.010000,
"payoutCurrency": "USD",
"payoutAmount": 6.010000,
"convRate": 1.000000,
"merchantNo": "800527",
"onBehalfOf": null,
"payeeName": "dante te",
"payoutStatus": "S",
"payoutTime": "2026-09-18 10:25:02",
"distributePs": "REFERENCE PAYPAL",
"transactionPurpose": "0",
"payoutMethod": "E_WALLET",
"createTime": "2026-09-18 10:18:16",
"updateTime": "2026-09-18 10:25:02",
"requestId": null,
"payoutStatusReason": ""
},
{
"payoutId": "2083068542462853120",
"settleCurrency": "USD",
"settleSumAmount": 12.230000,
"serviceFee": -5.120000,
"settleAmount": 7.110000,
"payoutCurrency": "HKD",
"payoutAmount": 54.580000,
"convRate": 7.675822,
"merchantNo": "800527",
"onBehalfOf": null,
"payeeName": "test swift company",
"payoutStatus": "S",
"payoutTime": "2026-07-31 13:55:18",
"distributePs": "REFERENCE SWIFT",
"transactionPurpose": "0",
"payoutMethod": "SWIFT",
"createTime": "2026-07-31 13:53:36",
"updateTime": "2026-07-31 13:55:18",
"requestId": null,
"payoutStatusReason": ""
}
],
"total": 3,
"size": 10,
"current": 1,
"pages": 1
}
}
}Pagination Description
- size: Number of records displayed per page
- current: Current page number
- total: Total number of records