Beneficiaries

Get a beneficiary

Get a beneficiary by beneficiary's identifier.

get/beneficiaries/{beneficiary_id}

Request

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

Response

The data of a beneficiary.

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.