You can list all payouts in your project with the all() function. See the section about listing resources to learn how to access the list in stages using pagination.

Filtering

If you are consuming our REST API interface, you can additionally filter the payouts, using following query parameters:

created_at_lte - allows to limit the results to the payouts that were created before specified date in RFC 3339 format.
created_at_gte - allows to limit the results to the payouts that were created after specified date in RFC 3339 format.
gateway_configuration_ids - allows to limit the results based on the list of gateways in which the payouts were processed. Example query: ?limit=100&gateway_configuration_ids=gway_conf_123&gateway_configuration_ids=gway_conf_456.
ids - allows to limit the results to the specified payout ids. Example query: ?limit=100&ids=payt_123&ids=payt_456.

All query parameters can be mixed to limit the results even more. Example query: ?limit=100&created_at_gte=2023-12-01T00:00:00.00000Z&ids=payt_123&ids=payt_456&gateway_configuration_ids=gway_conf_123

200200

401401

4XX4XX