---
title: "Edit an account"
method: PUT
path: "/accounts/{accountId}"
tags: ["Accounts"]
---

# Edit an account

`PUT /accounts/{accountId}`

Edit details of a particular account using its ID as a reference
Currently editable fields:
  1. for accounts of all customer types, externalReference can be edited
  2. for accounts of PCM_INDIVIDUAL & PCM_BUSINESS customer types, name can additionally be edited

## Path parameters

- `accountId` string, required

## Request body

- AccountUpdateAccountRequest — Details of account to edit
  - `externalReference` string — External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long
  - `name` string — Name for the account, only applicable for 'PCM_INDIVIDUAL' and 'PCM_BUSINESS' customer types

## Response `200`

OK

- AccountAccountResponse — Account
  - `id` string — Unique id for the account
  - `name` string — Name for the account
  - `balance` string — Balance of the account in format 'NN.NN'
  - `availableBalance` string — The current available balance of the Account. Calculated by subtracting any pending payments from the current balance
  - `currency` string — Currency of the account in ISO 4217 format
  - `status` string — Status of the account. Accounts must be 'ACTIVE' to make and receive payments. Can be one of
  - `identifiers` AccountIdentifierResponse[]
    - `type` string
    - `accountNumber` string — Bank account Sort Code
    - `accountType` 'PERSONAL' | 'BUSINESS' — Bank account type like PERSONAL/BUSINESS
    - `sortCode` string — Bank account Sort Code
    - `iban` string
    - `bic` string
    - `currency` string
    - `countrySpecificDetails` AccountIdentifierCountrySpecificDetailsResponse
      - `bankName` string — The name of the destination bank.
      - `bankAddress` string — The address of the destination bank.
      - `bankCity` string — The city in which the destination bank resides.
      - `bankBranchName` string — The name of the destination bank's branch.
      - `bankBranchCode` string — The code of the destination bank's branch.
      - `bankCode` string — The code identifying the target bank on its respective national network. This is not the BIC/SWIFT code. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.
      - `chineseId` string — The 18 digit identification code of the beneficiary. Applies to Chinese beneficiaries only.
      - `province` string — The province in which the beneficiary resides. Applies only to beneficiaries residing in China.
      - `business` boolean — The type of the beneficiary. 'true' for businesses, 'false' otherwise.
      - `bankCodeType` 'ABA' | 'CHIPS' — The code type identifying the target bank on its respective national network. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.
      - `bankCountry` 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'GR' | 'HR' | 'HU' | 'IS' | 'IE' | 'IT' | 'LV' | 'LI' | 'LT' | 'LU' | 'MT' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'GB' | 'MQ' | 'YT' | 'GP' | 'GF' | 'RE' | 'MF' | 'GI' | 'GG' | 'IM' | 'JE' | 'MC' | 'CH' | 'AD' | 'SM' | 'VA' | 'AX' | 'PM' | 'BL' | 'AL' | 'MD' | 'ME' | 'MK' | 'RS' | 'AF' | 'DZ' | 'AS' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'VG' | 'BN' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CU' | 'CW' | 'CD' | 'DJ' | 'DM' | 'DO' | 'TL' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'GH' | 'GL' | 'GD' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IL' | 'CI' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LB' | 'LS' | 'LR' | 'LY' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MH' | 'MR' | 'MU' | 'MX' | 'FM' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PR' | 'QA' | 'CG' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'VC' | 'WS' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SX' | 'SB' | 'SO' | 'ZA' | 'KR' | 'GS' | 'SS' | 'LK' | 'SD' | 'SR' | 'SY' | 'SJ' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — The country in which the destination bank resides.
      - `abaRoutingNumber` string — The 9 digit identification code of the beneficiary. Applies to US beneficiaries only.
    - `productId` string
  - `customerId` string — Unique id of the Customer
  - `customerName` string — Customer Name
  - `externalReference` string — Your reference for an account
  - `accessGroups` string[] — Ids of Access Groups this account belongs to
  - `createdDate` string, date-time — Datetime when the account was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
  - `directDebit` boolean — Direct Debit Enabled
  - `securedFundingLimit` string — Limit of funds available below a balance of zero

## Other responses

- `400` — Validation errors

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)