OPopenpayd

Update Bank Beneficiary

Update an existing Bank Beneficiary. The full set of Beneficiary Bank Details must be provided for updating.

put/beneficiaries/bank-beneficiaries/{id}

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/beneficiaries/bank-beneficiaries/{id}
  • Auth
    API key in header Authorization

Request body

paymentTypesstring[] required

Types of payments that the beneficiary can receive. See Supported Payment Types

beneficiaryTypestring required

CORPORATE, RETAIL

beneficiaryCountrystring required

Two-letter ISO 3166-1 alpha-2 country code e.g. GB

bankAccountCurrencystring

Three-letter ISO 4217 currency code in which the beneficiary bank account is held. e.g. EUR

bankAccountTypestring

Type of the bank account. e.g. Current, Savings

bankNamestring

Name of the bank where the account is held. e.g. HSBC UK

bankAddressstring

Address of the bank where the account is held.

bankAccountCountrystring

Two-letter ISO 3166-1 alpha-2 country code where the beneficiary bank account is held. e.g. GB

bankStatestring
bankCitystring
bankPostalCodestring
bankAccountHolderNamestring

Name appearing the beneficiary bank account.

accountNumberstring

Account number of the bank account.

ibanstring

IBAN of the bank account.

bicstring

SWIFT BIC of the bank account.

companyNamestring

Required if beneficiaryType is CORPORATE.

beneficiaryFirstNamestring

Required if beneficiaryType is RETAIL.

beneficiaryLastNamestring

Required if beneficiaryType is RETAIL.

beneficiaryBirthDatestring

YYYY-MM-DD e.g. 1986-04-29 for 29th April 1986

beneficiaryAddressLinestring
beneficiaryStatestring
beneficiaryCitystring
beneficiaryPostalCodestring
phoneNumberstring
friendlyNamestring

User friendly name associated with the bank beneficiary. e.g. My HSBC Account

taxIdstring

Tax Id of the beneficiary.

Response

200

Changes

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