Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

This method is used to retrieve the details of one or more seller payouts. By using the filter query parameter, users can retrieve payouts processed within a specific date range, and/or they can retrieve payouts in a specific state.

There are also pagination and sort query parameters that allow users to control the payouts that are returned in the response.

If no payouts match the input criteria, an empty payload is returned.

For split-payout cases, which are only available to sellers in mainland China, this method will return the payoutPercentage for the specified payout. This value indicates the current payout percentage allocated to a payout instrument. This method will also return the convertedToCurrency and convertedTo response fields set to CNY value and the payoutReference, the unique identifier reference (not true payout).

By using the filter query parameter, users can retrieve the two true(actual) payouts associated with a payoutReference.

Note: For more information on split payouts, see Mainland China Split Payout Playbook.

Type that uses RegionTypeEnum

Calls that use RegionTypeEnum

Enumerations