Retrieve a payout list

Retrieve all the payouts you made from your Merchant account. You can also use the query parameters for:

FilteringPagination
Filter the orders that you want to retrieve, for example, only retrieve the orders that have a specific email.

Parameters used for filtering:
  • from_created_date
  • to_created_date
  • currency
  • state
View the orders without loading all of them at once, for example, return a specified number of orders per page.

Parameters used for pagination:
  • limit

Request

Query Parameters
Query Parameters

Possible length: >= 3 characters and <= 3 characters

ISO 4217 currency code in upper case.

info

For more information about the supported currencies, see: Help Center.

Possible values: >= 1 and <= 500

The maximum number of payouts returned per page. Used for pagination.

Retrieve all payouts with a created_datefrom_created_date. Used for filtering.

Use the ISO date format: yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z.

Retrieve all payouts with a created_dateto_created_date. Used for filtering.

Use the ISO date format: yyyy-MM-ddTHH:mm:ss[.SSSSSS]Z. For example, 2021-02-10T16:59:50.886826Z.

Possible values: [processing, completed, failed]

Retrieve all payouts with specific states. You can pass several states. Used for filtering.

If multiple states are selected, for example completed and processing, payouts with either of the selected values are returned. See this example of such a request URL:

https://merchant.revolut.com/api/payouts?state=completed&state=processing

The parameter is case sensitive.

Header Parameters
Header Parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

info

For more information, see: Authentication

Possible values: [2023-09-01, 2024-05-01, 2024-09-01, 2025-10-16]
Example: "2025-10-16"

The version of the Merchant API, specified in YYYY-MM-DD format.

If not specified, you will receive an error.

info

For more information about API versioning, see: API versions.

Response

Payouts retrieved

Response body
Body array of objects

Permanent payout ID used for payouts operations.

Possible values: [processing, completed, failed]

The state of the payout.

The date and time the payout was created.

Possible values: [current_pocket, external_beneficiary]

The destination of the payout funds when a merchant initiates a withdrawal from their merchant account.

Destination typeDescription
current_pocketThe funds were moved from the merchant account to the business account within the platform. This indicates an internal transfer, allowing the merchant to access the funds within their own business account.
external_beneficiaryThe funds were transferred to an external bank account or beneficiary outside the platform. This indicates a transfer to an external account, enabling the merchant to withdraw funds to external financial institutions.

Possible values: >= 1

The total amount of the payout in minor currency units. For example, 7034 represents €70.34.

Possible length: >= 3 characters and <= 3 characters

ISO 4217 currency code in upper case.

info

For more information about the supported currencies, see: Help Center.

Was this page helpful?