Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Accounts

Edit an account

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
put/accounts/{accountId}

Path parameters

accountIdstring required

ID of account to be edited

Request body

externalReferencestring

External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long

namestring

Name for the account, only applicable for 'PCM_INDIVIDUAL' and 'PCM_BUSINESS' customer types

Response

OK

idstring

Unique id for the account

namestring

Name for the account

balancestring

Balance of the account in format 'NN.NN'

availableBalancestring

The current available balance of the Account. Calculated by subtracting any pending payments from the current balance

currencystring

Currency of the account in ISO 4217 format

statusstring

Status of the account. Accounts must be 'ACTIVE' to make and receive payments. Can be one of

customerIdstring

Unique id of the Customer

customerNamestring

Customer Name

externalReferencestring

Your reference for an account

accessGroupsstring[]

Ids of Access Groups this account belongs to

createdDatestring 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

directDebitboolean

Direct Debit Enabled

securedFundingLimitstring

Limit of funds available below a balance of zero

Example response

{
  "id": "A0000001",
  "balance": "10000.00",
  "availableBalance": "10000.00",
  "currency": "GBP",
  "status": "ACTIVE",
  "identifiers": [
    {
      "accountNumber": "12345678",
      "sortCode": "000000",
      "iban": "GB20MODR04001401100000",
      "bic": "MODRGB21",
      "currency": "GBP",
      "countrySpecificDetails": {
        "bankName": "Apple Bank",
        "bankAddress": "2100 Broadway",
        "bankCity": "New York City",
        "bankBranchName": "New York",
        "bankBranchCode": "44-04",
        "chineseId": "01101201901018889",
        "province": "Zhejiang",
        "business": true,
        "bankCodeType": "ABA",
        "bankCountry": "US",
        "abaRoutingNumber": "123456789"
      },
      "productId": "O2100001"
    }
  ],
  "customerId": "C0000001",
  "externalReference": "aReference_00001",
  "createdDate": "2017-01-28T01:01:01+0000"
}