Beneficiaries V2

Search beneficiaries (V2)

Search the beneficiaries of a given client. Each beneficiary has a single bank account.

get/v2/beneficiaries

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/v2/beneficiaries
  • Auth: API key in header x-api-key

Query parameters

pageinteger

The page number for pagination.

items_per_pageinteger

The number of beneficiaries per page.

order_by'beneficiary_name' | 'created_date'

The field to order the results by.

order_direction'asc' | 'desc'

The direction to order the results in.

localestring

The language locale.

local_routing_identifierstring

Filter. The local routing identifier of the bank (e.g. Sort Code, ABA, routing number).

bank_account_ibanstring

Filter. The IBAN of the bank account.

bank_account_numberstring

Filter. The account number of the bank account.

bank_account_currency_codestring[]

Filter. The ISO 4217 currency codes of the bank account. Repeat the parameter to pass several values.

created_on_fromstring date

Filter. The earliest creation date, as YYYY-MM-DD.

created_on_tostring date

Filter. The latest creation date, as YYYY-MM-DD.

beneficiary_idstring[]

Filter. The identifiers of the beneficiaries. Repeat the parameter to pass several values.

bank_country_codestring[]

Filter. The ISO 3166-1 alpha-2 codes of the bank's country. Repeat the parameter to pass several values.

query_textstring

Filter. Free text search.

Response

Will successfully list the requested beneficiaries.

idstring required

The identifier of the beneficiary.

aml_statusstring nullable

The AML/screening status of the beneficiary.

activeboolean required

True if beneficiary is active, False otherwise.

editableboolean required

True if beneficiary is editable, False otherwise.

is_first_partyboolean required

True if beneficiary is a first party, False otherwise.

created_datestring required

The date and time when the beneficiary was created.

namestring nullable

The alias/display name of the beneficiary. The beneficiary's name is bank_account.holder_name.

type'personal' | 'business' | 'null' nullable

The type of the beneficiary.

external_referencestring nullable

The unique external reference submitted by the client for the beneficiary.

phone_numberstring nullable

The phone number of the beneficiary.

payouts_emailstring nullable

The email of the beneficiary to use during payouts.

identification_typestring nullable

The identification (e.g. TAX ID) type of the beneficiary.

identification_valuestring nullable

The identification (e.g. TAX ID) value of the beneficiary.

Changes

No recorded changes to this operation across all 1 revision of this API.