API Reference

List payouts

get
https://recipient.payouts.com/api/v1/payouts

Retrieve a paginated list of payouts with optional filtering by status, date range, and other criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter by payout status

Allowed:
string

Filter by recipient email address

date-time

Start date for date range filter (ISO 8601 format)

date-time

End date for date range filter (ISO 8601 format)

integer
≥ 1
Defaults to 1

Page number for pagination

integer
1 to 100
Defaults to 20

Number of results per page

string
enum
Defaults to createdAt

Sort field

Allowed:
string
enum
Defaults to desc

Sort order

Allowed:
Responses

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
API Key
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?