Skip to main content
GET
Get Payouts | Payouts API
This API retrieves a paginated list of payouts based on specified filters.
Payouts are only available for Pay by Bank (Open Banking) payments. This feature is not enabled by default and is only accessible to merchants who have been granted payout access. Contact support if not enabled.

Authorization

Bearer <token>

Query Parameters

integer
Maximum number of records to return per page. Default: 20
integer
Page number for pagination, starting from 0. Default: 0
string
Start date for filtering (YYYY-MM-DD format)
string
End date for filtering (YYYY-MM-DD format)
string
Sort order for results. Values: ASC or DESC. Default: DESC
string
Filter by payout status. Possible values: PENDING, PROCESSING, SETTLED, FAILED
Search term to filter results (e.g., amount, reference)

Response

array
List of payout records
integer
Current page number
integer
Number of items per page
integer
Total number of records matching the query