Search beneficiaries (V2)
Search the beneficiaries of a given client. Each beneficiary has a single bank account.
Headers
The access token.
Query Parameters
The page number for pagination.
x >= 1The number of beneficiaries per page.
x >= 1The field to order the results by.
beneficiary_name, created_date The direction to order the results in.
asc, desc The language locale.
Filter. The local routing identifier of the bank (e.g. Sort Code, ABA, routing number).
Filter. The IBAN of the bank account.
Filter. The account number of the bank account.
Filter. The ISO 4217 currency codes of the bank account. Repeat the parameter to pass several values.
Filter. The earliest creation date, as YYYY-MM-DD.
Filter. The latest creation date, as YYYY-MM-DD.
Filter. The identifiers of the beneficiaries. Repeat the parameter to pass several values.
Filter. The ISO 3166-1 alpha-2 codes of the bank's country. Repeat the parameter to pass several values.
Filter. Free text search.
The identifier of a client.
Response
Will successfully list the requested beneficiaries.
The identifier of the beneficiary.
True if beneficiary is active, False otherwise.
True if beneficiary is editable, False otherwise.
True if beneficiary is a first party, False otherwise.
The date and time when the beneficiary was created.
The notification preferences of a beneficiary.
An address of a beneficiary or of a bank.
The bank account of a beneficiary.
The AML/screening status of the beneficiary.
The alias/display name of the beneficiary. The beneficiary's name is bank_account.holder_name.
The type of the beneficiary.
personal, business, null The unique external reference submitted by the client for the beneficiary.
The phone number of the beneficiary.
The email of the beneficiary to use during payouts.
The identification (e.g. TAX ID) type of the beneficiary.
The identification (e.g. TAX ID) value of the beneficiary.