Fetch user beneficiaries

get

https://api-beneficiary-sandbox.vertofx.com/recipients

Retrieve a paginated list of beneficiaries for the authenticated user with filtering and search capabilities

📘
NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangeably will result in 403 errors.

Param	Use
`limit` / `skip`	Pagination.
`searchQuery`	Search by name, account number, bank, or reference.
`isSelfAccount`	`true` = your accounts; `false` = third-party recipients.
`stablecoin`	`true` = stablecoin only; omit/`false` = non-stablecoin.
`currencyId`	Filter by currency.
`accountId`	Fetch one beneficiary by id.
`accountNumbers`	Match account number(s).
`reference`	Filter by reference.
`isAccountActive`	Active vs inactive.
`needsUpdate`	When `true`, omit beneficiaries that need a forced update.

Query Params

limit

int32

≤ 100

max records to return

skip

int32

number of items to skip

searchQuery

string

Search by name, account number, bank name, or reference.

currencyId

string

Return only beneficiaries for this currency id. See the guide on Currency Codes Mapping for valid values.

accountId

string

Return the beneficiary with this id.

accountNumbers

string

Comma-separated account numbers to match (up to 100).

stablecoin

true — stablecoin beneficiaries only.
false or omit — non-stablecoin beneficiaries.

boolean
string

isSelfAccount

string

true — your own company accounts only.
false — third-party recipients only.

reference

string

Filter by beneficiary reference (or comma-separated list).

isAccountActive

boolean

Filter by active (true) or inactive (false) beneficiaries.

needsUpdate

boolean

When true, omit beneficiaries that require a forced update
(isUpdateRequired on the response).

Responses

200Successfully retrieved user beneficiaries

400Invalid query parameters

401Unauthorized