Filter Payouts
Returns a paginated list of payouts for the authenticated merchant with advanced filtering capabilities.
This endpoint provides comprehensive search functionality using the SearchIndex infrastructure, allowing you to filter payouts by various criteria including status, payout method, currency, amount ranges, and date ranges.
The response includes pagination controls with previous and next cursors that can be used
to navigate through the payout history efficiently.
Features:
- Full-text search: Search across payout content
- Advanced filtering: Filter by status, payout method, currency, amount, and dates
- Date range support: Support for specific dates, datetimes, date ranges, datetime ranges, and keywords
- Pagination: Efficient cursor-based pagination
- Merchant-scoped: Only returns payouts for the authenticated merchant
per_page
number
Optional. Number of payouts to return per page. Default: 10, Maximum: 100
page
number
Optional. Page number for pagination. Default: 1 (first page)
status
string
Optional. Filter by payout status. Examples: 'PENDING', 'SENT', 'SUCCESSFUL', 'FAILED', 'CANCELLED'
Allowed values:PENDINGSENTSUCCESSFULFAILEDCANCELLED
created_at
string
Optional. Filter by creation date/time. Supports: specific date (YYYY-MM-DD), datetime (ISO8601), date range (YYYY-MM-DD..YYYY-MM-DD), datetime range (ISO8601..ISO8601), or keywords (today, yesterday, this_week, last_week, this_month, last_month)
paid_at
string
Optional. Filter by paid date/time. Supports: specific date (YYYY-MM-DD), datetime (ISO8601), date range (YYYY-MM-DD..YYYY-MM-DD), datetime range (ISO8601..ISO8601), or keywords (today, yesterday, this_week, last_week, this_month, last_month)
sent_at
string
Optional. Filter by sent date/time. Supports: specific date (YYYY-MM-DD), datetime (ISO8601), date range (YYYY-MM-DD..YYYY-MM-DD), datetime range (ISO8601..ISO8601), or keywords (today, yesterday, this_week, last_week, this_month, last_month)
payout_method
string
Optional. Filter by payout method name.
currency
string
Optional. Filter by currency code. Examples: 'THB', 'USD'. Case-insensitive.
amount
string
Optional. Filter by amount. Supports: exact amount (1000), range (1000..5000), or boundless ranges (1000.. or ..5000). Amounts are in the smallest currency unit (cents for USD).
bank_code
string
Optional. Filter by bank code.
contact_id
string
Optional. Filter by contact ID. Accepts either internal UID (starting with ctc_ ) or external ID. Examples: ctc_1234567890 or ext_1234567890
terms
string
Optional. Full-text search across payout content. Searches payout method names. Uses fuzzy matching for partial text matches.
| Attribute | Description |
|---|---|
previousobject
|
Pagination for the previous page. Contains 'before' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the previous page. Returns null if there is no previous page. |
pagearray
|
The current page of records, ordered by creation date (newest first). Each record is serialized according to the specified record_serializer option. |
nextobject
|
Pagination for the next page. Contains 'after' (page number) and 'perpage' (page size) parameters. Use these values in the 'page' and 'perpage' parameters of the next request to get the next page. Returns null if there is no next page. |
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.