---
title: "Update Bank Beneficiary"
method: PUT
path: "/beneficiaries/bank-beneficiaries/{id}"
---

# Update Bank Beneficiary

`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`

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

## Request body

- object
  - `paymentTypes` string[], required: Types of payments that the beneficiary can receive. See [Supported Payment Types](doc:payment-types)
  - `beneficiaryType` string, required: `CORPORATE`, `RETAIL`
  - `beneficiaryCountry` string, required: Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code e.g. `GB`
  - `bankAccountCurrency` string: Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in which the beneficiary bank account is held. e.g. `EUR`
  - `bankAccountType` string: Type of the bank account. e.g. `Current`, `Savings`
  - `bankName` string: Name of the bank where the account is held. e.g. `HSBC UK`
  - `bankAddress` string: Address of the bank where the account is held.
  - `bankAccountCountry` string: Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the beneficiary bank account is held. e.g. `GB`
  - `bankState` string
  - `bankCity` string
  - `bankPostalCode` string
  - `bankAccountHolderName` string: Name appearing the beneficiary bank account.
  - `accountNumber` string: Account number of the bank account.
  - `bankRoutingCodes` object[]: Routing codes associated with the bank account.
    - `routingCodeKey` '`ABA`' | '`BLZ_CODE`' | '`BRANCH_CODE`' | '`BSB_CODE`' | '`SORT_CODE`' | '`IFS_CODE`' | '`CLABE_CODE`' | '`CTN`' | '`INTERMEDIARY_BIC`': `ABA`, `BLZ_CODE`, `BRANCH_CODE`, `BSB_CODE`, `SORT_CODE`, `IFS_CODE`, `CLABE_CODE`, `CTN`, `INTERMEDIARY_BIC`
    - `routingCodeValue` string
  - `iban` string: IBAN of the bank account.
  - `bic` string: SWIFT BIC of the bank account.
  - `companyName` string: Required if `beneficiaryType` is `CORPORATE`.
  - `beneficiaryFirstName` string: Required if `beneficiaryType` is `RETAIL`.
  - `beneficiaryLastName` string: Required if `beneficiaryType` is `RETAIL`.
  - `beneficiaryBirthDate` string: `YYYY-MM-DD` e.g. `1986-04-29` for 29th April 1986
  - `beneficiaryAddressLine` string
  - `beneficiaryState` string
  - `beneficiaryCity` string
  - `beneficiaryPostalCode` string
  - `phoneNumber` string
  - `friendlyName` string: User friendly name associated with the bank beneficiary. e.g. `My HSBC Account`
  - `taxId` string: Tax Id of the beneficiary.
  - `metadata` object: Set of key-value pairs that you can attach to the Bank Beneficiary Object. Useful for storing additional, structured information on the Beneficairy. e.g your internal ID of your user etc.<br> e.g `"userId":"ABC1234, "userName":"Boris Johnson"
    - `CONCEPT_CODE` 'C_0001' | 'C_0002' | 'C_0003' | 'C_0004' | 'C_0005' | 'C_0006' | 'C_0007' | 'C_0008' | 'C_0009' | 'C_0010' | 'C_0011' | 'C_0012' | 'C_0013' | 'C_0014' | 'C_0015' | 'C_0016' | 'C_0017' | 'C_0018' | 'C_0019' | 'C_0020' | 'C_0021' | 'C_0022' | 'C_0023' | 'C_0024' | 'C_0025' | 'C_0026' | 'C_0027' | 'C_0028' | 'C_0029' | 'C_0030' | 'C_0031' | 'C_0032' | 'C_0033' | 'C_0034' | 'C_0035' | 'C_0036' | 'C_0037' | 'C_0038' | 'C_0039' | 'C_0040' | '': OpenPayd currently supports the following [concept codes](ref:concept-codes) for Pix payments.

## Response `200`

200

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-api.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-api/revisions/0f820ef79fab?raw)