Payrexx Octri Demo
GET/Payout/

List payouts

Lists payout records with their amounts, currencies, statuses, and related payout data. Use limit and offset to control the number of records and starting position, and orderByDate to choose the date order.

3 body fields

Payout list options for controlling the result range and sort order.

limitintegeroptional
Max row count
offsetintegeroptional
Row count to be used as offset
orderByDatestringoptional
ASC (ascending) or DESC (descending) for ordering by date of the payout
Default:Defaults to ASC

2 status codes
200Returns an object containing a `data` array of payout records and a `status` field.
dataarray<object>optional
statusstringoptional
400Returned when a request value is invalid.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

orderByDate must be ASC or DESC; invalid request values return a 400. limit and offset control the result range and must be valid integers.