Skip to main content

List payout requests

GET 
/svc/ts/api/v1/openapi/payout_requests

List payout requests under the current business, ordered by created_at descending.

Pagination​

  • offset: starting record offset (default 0)
  • limit: page size (default 10, max 1000)
  • 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​

FieldOpsNotes
id_eq, _neqPayout request ID
reference_id_eq, _neqClient reference from create
payee_id_eq, _neqPayee ID
currency_eq, _neqe.g. HKD
transfer_status_eq, _neqSee TransferStatus
transfer_method_eq, _neqe.g. HK FPS - Account Number
amount_eq, _neq, _gt, _gte, _lt, _lteDecimal amount
created_at_eq, _neq, _gt, _gte, _lt, _lteRFC3339 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-0001

Request​

Responses​

Listed successfully. Total count is in header X-List-Total.

Response Headers
    X-List-Total

    Total number of matching payout requests (before pagination).

    Example: 42