Skip to main content
GET
List Payouts

Overview

Retrieve a paginated list of payouts with optional filtering.

Query Parameters

Response

Payout Object (Summary)

Example Usage

Example Response

Filtering Examples

By Recipient

Failed Payouts

Search by Reference

Date Range

Export for Accounting

Use date filtering and pagination to export payout data for reconciliation:
Use payout reports for payroll reconciliation, tax reporting, and financial audits.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
status
enum<string>
Available options:
PENDING,
COMPLETED,
FAILED
reference
string

Search by reference (partial match)

recipient
string

Search by recipient (client ID or name)

dateFrom
string<date>

Filter from date (YYYY-MM-DD)

dateTo
string<date>

Response

Payouts retrieved successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object