/api/v1/openapi/payout_requestsList payout requests
List payout requests under the current business, ordered by created_at descending.
Pagination
offset: starting record offset (default0)limit: page size (default10, max1000)- Total count is returned in response header
X-List-Total
Filtering (Advanced Query DSL)
Uses the Wonder Advanced Query DSL format:
filter[field_name][operation]=value
Multiple filters are combined with AND.
Supported filter fields
| Field | Ops | Notes |
|---|---|---|
id | _eq, _neq | Payout request ID |
reference_id | _eq, _neq | Client reference from create |
payee_id | _eq, _neq | Payee ID |
currency | _eq, _neq | e.g. HKD |
transfer_status | _eq, _neq | See TransferStatus |
transfer_method | _eq, _neq | e.g. HK FPS - Account Number |
amount | _eq, _neq, _gt, _gte, _lt, _lte | Decimal amount |
created_at | _eq, _neq, _gt, _gte, _lt, _lte | RFC3339 datetime |
Unsupported fields/ops or invalid values → 800000 parameter error.
Examples
# By status
filter[transfer_status][_eq]=Settled
# By payee and currency
filter[payee_id][_eq]=7c9e6679-7425-40de-944b-e07fc1f90ae7&filter[currency][_eq]=HKD
# Created in a date range
filter[created_at][_gte]=2026-01-01T00:00:00+08:00&filter[created_at][_lte]=2026-01-31T23:59:59+08:00
# Amount range
filter[amount][_gte]=100&filter[amount][_lte]=500
# By reference_id
filter[reference_id][_eq]=INV-2026-0001Query parameters
Starting record offset. Default `0`.
Example: 0
Page size. Default `10`, maximum `1000`.
Example: 20
Example filter — equality on `transfer_status`. See description for full field/op matrix.
Example: Settled
Example filter — equality on `payee_id`.
Example:
Example filter — equality on `currency`.
Example: HKD
Example filter — equality on `reference_id`.
Example: INV-2026-0001
Example filter — created_at greater than or equal (RFC3339).
Example: 2026-01-01T00:00:00+08:00
Example filter — amount greater than or equal.
Example: 100
Header parameters
Example: TRUE
Example: good
Example: {{credential}}
Example: {{$string.uuid}}
Example: zh-CN
Example: application/json
Responses
Listed successfully. Total count is in header `X-List-Total`.
Always 200 on success
200
Example: 200
Always succeed on success
succeed
Example: succeed