List recipients

Lists the payout recipients registered for your application, newest first.

By default DEACTIVATED recipients are excluded — pass status explicitly to see them. Use a recipient's id as the beneficiaryId on a payout.

Recipients appear as PENDING until sanctions screening completes, then flip to ACTIVE. Only ACTIVE recipients can be paid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Lifecycle state of a recipient. PENDING means sanctions screening has not finished yet; only ACTIVE recipients can be paid.

Allowed:
integer
1 to 100
Defaults to 50

Page size, 1-100.

integer
≥ 0
Defaults to 0

Number of records to skip.

Responses

401

Missing or invalid api-key / HMAC signature.

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