Retrieve payouts

Learn how to retrieve payouts by date or settlement.

Prerequisites

To make calls to the Transfers API, you must have:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• Approval for the Finance and Accounting role in your developer profile.
• The Finance and Accounting role selected in the app registration page for your application.

Retrieve payouts for a date range

Call the listPayouts operation with the createdAfter and createdBefore query parameters to list all payouts within that time range.

Retrieve payouts for a specific settlement

Call the listPayouts operation with the payoutId query parameter to list all payouts for the specified settlement.