List recipients

Lists your business's recipients, newest first. Each item has the same fields as Fetch recipient, including the bank and address details. Deleted recipients are not included.

Results are paginated: 10 recipients per page by default, up to 1000 with per_page. The response's pagination_meta tells you whether more pages exist; see Pagination for how to fetch every page.

Query Params
integer
≥ 1

Page number to fetch (1-indexed). Defaults to 1; a value of 0 is treated as the first page.

integer
1 to 1000

Number of recipients per page (maximum 1000).

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json