# PayoutFilter

> A schema in the Payouts API reference. Source: https://hub.ozow.com/api-reference/payouts-api/schemas/payout-filter/

Search and pagination criteria for listing a site's payouts.

## Fields

- `pageSize` (integer) - How many payouts to return per page. Below 1 is treated as 1.
- `pageIndex` (integer) - Which page to return, counting from 1. Below 1 is treated as 1.
- `searchFields` (array of PayoutField) - Which fields `searchString` is matched against.
- `searchString` (string) - The value to search for in the fields named by `searchFields`.
- `sortField` (integer, one of 0, 1, 2, 3, 4) - The field to order the results by.
- `minAmount` (number) - Exclude payouts below this amount.
- `maxAmount` (number) - Exclude payouts above this amount.
- `dateFrom` (string, date-time) - Exclude payouts created before this moment.
- `dateTo` (string, date-time) - Exclude payouts created after this moment.
- `isRtc` (boolean) - Return only real time clearing payouts.
- `bulkReference` (string) - Return only payouts from the bulk upload with this reference.