Skip to main content
GET
List payouts

Path Parameters

businessId
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

source
enum<string>[]

The sources to list payouts from. Omit this parameter to list all sources.

Available options:
halth,
health_fund
status
enum<string>
Available options:
paid,
pending,
in_transit,
canceled,
failed
arrivesAtMin
string<date-time>
arrivesAtMax
string<date-time>

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10