Beneficiaries

Update a beneficiary

Update a beneficiary by beneficiary's identifier.

patch/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

Request body

account_numberstring

The account number of the bank account.

bank_address_line_1string

The first address line of the bank.

bank_country_codestring required

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

bank_currency_codestring required

The ISO 4217 code of the bank account's currency.

bank_identifierstring

The identifier of the bank.

bank_namestring

Name of the bank account holder.

correspondent_accountstring

The account for the correspondant account of the bank.

correspondent_swift_codestring

The SWIFT code for the correspondant account of the bank.

ibanstring

The IBAN of the bank account.

innstring

The INN of the bank account.

kbkstring

The KBK of the bank account.

kiostring

The KIO of the bank account.

kppstring

The KPP of the bank account.

purpose_of_payment'/CGODDR/' | '/CGODDR/PART/' | '/CGODDR/RETN/' | '/CSTRDR/' | '/CSTRDR/PART/' | '/CSTRDR/RETN/' | '/COCADR/' | '/COCADR/RTN/' | '/CCTFDR/' | '/CCTFDR/PART/' | '/CCTFDR/RETN/' | '/CCDNDR/' | '/CCDNDR/RTN/' | 'GDE' | 'GDI' | 'GMS' | 'STS' | 'ATS' | 'OTS' | 'STR' | 'SCO' | 'INS' | 'FIS' | 'IPC' | 'TCS' | 'ITS' | 'IFS' | 'RDS' | 'PMS' | 'TTS' | 'PRS' | 'GOS' | 'SAL' | 'IGD' | 'IID' | 'PIP' | 'PRR' | 'DOE' | 'ISH' | 'ISL' | 'ISS' | 'IOL' | 'IOD' | 'GRI' | 'CHC' | 'EDU' | 'ALW' | 'AES' | 'LAS' | 'OVT' | 'TKT' | 'SAA' | 'COP' | 'COM' | 'EOS' | 'BON' | 'PEN' | 'UTL' | 'DCP' | 'LND' | 'LIP' | 'IPO' | 'POR' | 'RNT' | 'LNC' | 'EMI' | 'DIV' | 'ACM' | 'CCP' | 'POS' | 'MCR' | 'CIN' | 'TOF' | 'IGT' | 'OAT' | 'SVI' | 'SVO' | 'SVP' | 'MWI' | 'MWO' | 'MWP' | 'PRP' | 'PRW' | 'IRP' | 'IRW' | 'CEA' | 'PPA' | 'DSF' | 'DLF' | 'FSA' | 'FIA' | 'DSA' | 'DLA' | 'FDA' | 'AFA' | 'SLA' | 'LLA' | 'LEA' | 'RFS' | 'TCR' | 'CEL' | 'PPL' | 'LDS' | 'LDL' | 'FSL' | 'FIL' | 'DSL' | 'DLL' | 'FDL' | 'AFL' | 'SLL' | 'LLL' | 'LEL' | 'RLS' | 'TCP' | 'TAX' | 'REL' | 'RDL' | 'REA' | 'RDA'

Text explaining the purpose of payment. Required by the Central Bank for all payments sent to China (CHN) in the Chinese Renminbi (CNY) currency or United Arab Emirates in any currency (GDE to RDA) [Coming soon].

reason_for_tradestring

The reason for trade of the bank account.

reference_informationstring

The reference information of the bank account.

russian_central_bank_accountstring

The Russian central account number of the bank account.

swift_codestring

The SWIFT code of the bank account.

vostring

The VO of the bank account.

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.

account_name_change_allowedboolean

When true, allows updating the bank account holder name (bank_name) on a beneficiary that has already received a payment. bank_name is required when this flag is true.

Response

Beneficiary updated.

Changes

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