Skip to main content
GET
List Payouts

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

date_from
string<date>

ISO format (YYYY-MM-DD)

date_to
string<date>

ISO format (YYYY-MM-DD)

statuses
enum<string>[]

The payout statuses to filter for, comma separated

Available options:
EXECUTED,
CREATED,
PROCESSING,
PROCESSING_FUNDS,
CANCELLED,
FAILED,
FUNDED,
SUBMITTED
currencies
string[]
payout_types
enum<string>[]
Available options:
MANUAL,
SCHEDULED,
SETTLEMENT
mandate_id
string
sender_account_id
string
recipient_account_id
string
recipient_user_id
string
recipient_external_user_id
string
offset
integer
default:0

Default is 0

limit
integer
default:500

default is 500, max is 1000

Required range: 1 <= x <= 1000

Response

Success

payouts
object[]
required
total_payouts
integer
required