Get All Beneficiaries

Use this API to get all beneficiaries for an account.

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

Unique identifier of the account to which the beneficiary is linked.

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Query Params
string

The beneficiary_id after which details should be returned.

Use this with the results_per_page for pagination.

Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

string

The beneficiary_id before which details should be returned.

Use this with the results_per_page for pagination.

Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

string
Defaults to 10

The number of results you want to get per API call.

Use this with the start_before or start_after parameters for pagination.

  • Default value 10.
  • Maximum value 100.
Example: 15

string

Has to be used with to_date.

The UNIX timestamp after which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

string

Has to be used with from_date.

The UNIX timestamp before which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

Responses

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