Beneficiaries

Get beneficiaries

Get all beneficiaries for a given client.

get/beneficiaries

Request

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

Query parameters

namestring

Filter. The name of the beneficiary you want to search.

beneficiary_referencestring

Filter. Unique external reference ID submitted by the client for the beneficiary.

bank_currency_codestring

Filter. The currency of the beneficiary's account.

account_numberstring

Filter. The account number of the beneficiary you want to search.

ibanstring

Filter. The iban of the account of the beneficiary you want to search.

bank_identifierstring

Filter. The bank identifier of the account of the beneficiary you want to search.

active'true' | 'false' | 'all'

Filter. Whether to return active, inactive, or all beneficiaries (no null bank accounts). Defaults to active only.

pageinteger

The desired page number for pagination. By default is 1.

page_sizeinteger

The number of items per page for pagination. By default is 50.

Response

Will successfully list the requested beneficiaries

address_line_1string

The first address line of the beneficiary.

apartment_office_numberstring

The apartment/office number of the beneficiary. Does not apply to Ebury Mass Payments customers.

beneficiary_referencestring

The reference for the beneficiary.

building_numberstring

The building number of the beneficiary. Does not apply to Ebury Mass Payments customers.

citystring

The city of the beneficiary. Does not apply to Ebury Mass Payments customers.

country_codestring

The ISO 3166-1 alpha-2 code of the beneficiary's country.

email_addressesstring[]

The list of beneficiary's email addresses.

email_notificationboolean

Whether the beneficiary should receive email notification of payments.

floorstring

The floor of the beneficiary. Does not apply to Ebury Mass Payments customers.

namestring

The name of the beneficiary.

post_codestring

The post code of the beneficiary.

state_regionstring

The state/region of the beneficiary. Does not apply to Ebury Mass Payments customers.

street_namestring

The street name of the beneficiary. Does not apply to Ebury Mass Payments customers.

Changes

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