v1
latestOpenAPI 3.1.02026-07-24233206489.1 KBGet Payout List
Retrieve a list of payouts with filtering and pagination options
get/v1/payouts
Query parameters
searchstring
Search for payouts by ID or merchant ID
payout_status'pending' | 'on_hold' | 'in_transit' | 'deposited' | 'returned' | 'cancelled'
Filter by payout status
sort_by'created_at' | 'net_amount'
Field to sort results by
order'asc' | 'desc'
Sort order (ascending or descending)
provider'paymongo_central_hub' | 'unionbank'
Filter by payout provider
created_at.betweenstring
Filter payouts created between these dates (format: YYYY-MM-DD..YYYY-MM-DD)
limitinteger
Maximum number of records to return
afterstring
Cursor for pagination (get records after this cursor)
beforestring
Cursor for pagination (get records before this cursor)
Response
Successful response