List beneficiaries

Returns beneficiaries owned by the authenticated client, most recent first.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Query parameters

currencystringOptional
statuslist of enumsOptional

Filter by one or more statuses. Repeatable — e.g. ?status=pending&status=active.

Allowed values:
createdAfterdatetimeOptional
createdBeforedatetimeOptional
limitintegerOptional1-200Defaults to 20
Maximum number of results to return. Default 20, max 200.
cursorstringOptional

Opaque cursor from nextCursor of a previous response.

Response

Paginated list of beneficiaries.
beneficiarieslist of objects
nextCursorstring or null

Opaque cursor for the next page. null when the list is exhausted.

hasMoreboolean

Convenience flag. false when nextCursor is null.

Errors

400
Bad Request Error
401
Unauthorized Error