/api/v1/openapi/payout_requestsList payout requests
Lists payout requests under the current business using the Advanced query DSL.
Query parameters
Filter conditions in query DSL
Page offset
Page limit on line count
Example filter — equality on transfer_status. See description for full field/op matrix.
InitiatedProcessing TransferSuspendedSettledReversedTerminatedRefunded
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: 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
Response data
Payout request list