e445c15e5bee
List client settlement transfers
Lists all settlement transfers for your OES client account.
Requires access token scope: settlement_network_read
Path parameters
Query parameters
The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.
Optional array of currencies. If provided will only return settlement transfers with those currencies.
Optional array of user ids. If provided will only return settlement transfers for settlements initiated by those users.
Optional array of partner ids. If provided will only return settlement transfers for settlements initiated by those partners.
Optional array of settlement ids. If provided will only return settlement transfers for settlements with those ids.
Optional array of settlement statuses. If provided will only return settlement transfers for settlements in those statuses.
Optional array of settlement transfer statuses. If provided will only return settlement transfers with those statuses.
optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated before the provided date.
optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated on or after the provided date.
Response
OK