Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Bank accounts

Update a bank account

patch/v0/bank/accounts/{bank-account-id}

Path parameters

bank-account-idstring required

Request body

display-namestring required

A human readable label for an entity

Response

OK

account-restrictedboolean required

Specifies whether the bank account has restrictions applied by Griffin.

bank-product-type'savings-account' | 'client-money-account' | 'safeguarding-account' | 'embedded-account' | 'operational-account' required

Specifies the type of bank account. (For more detail on bank account types, see our guide for types of bank accounts.

display-namestring required

The mutable display name for the bank account

controller-urlstring required

Link to the legal person that represents the controller of the account.

pooled-fundsboolean required

Specifies whether the bank account holds funds belonging to multiple beneficiaries.

account-status'closing' | 'open' | 'closed' | 'opening' required

Shows the status of the account. An account can be moved between statuses during its lifecycle. The status value affects the operations that you can perform. An account must be "open" to be fully operational.

client-money-type'designated-client-fund' | 'designated-client-money' | 'general-client-money'

Specifies the type of client money account.

closed-atstring date-time

ISO 8601 formatted date-time.

created-atstring date-time required

ISO 8601 formatted date-time.

opened-atstring date-time

ISO 8601 formatted date-time.

primary-accountboolean required

Specifies whether the bank account is the organization's primary account.

savings-type'easy-access' | 'bare-trust'

Specifies the type of savings account.

Example response

{
  "display-name": "Reserve a/c",
  "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  "accrued-interest": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "available-balance": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "bank-addresses": [
    {
      "bank-id": "123456",
      "account-number": "12345678"
    }
  ],
  "account-balance": {
    "currency": "GBP",
    "value": "1000.00"
  }
}