Skip to main content

Rename a Bank Account

Changes a bank account's name, so an account holding several can tell them apart. Nothing else about the bank account changes. An inactive bank account can be renamed too.

New in v3: v2 has no equivalent.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

PATCH

/v3/bank-accounts/{bank_account_id}

Path parameters​

ParameterTypeDescription
bank_account_idstring (bnk_…)Required. The bank account.

An account-scoped key renames only its own account's bank accounts; another account's reads as 404. A workspace-scoped key renames any bank account of the workspace.

Request Body Sample​

{
"name": "Rent money"
}

Request Body Schema​

FieldTypeDescription
namestringRequired. The new name: 1 to 60 characters once leading and trailing spaces are dropped.

Response Sample​

{
"id": "bnk_01k8x4p6sx9t5v7x1z3b5d7f9h",
"customer_id": "cst_01h455vb4pex5vsknk084sn02q",
"kind": "deposit",
"name": "Rent money",
"reference": "K7Q2MZ",
"account_number": "555000114027",
"currency": "USD",
"status": "active",
"is_default": false,
"created_at": "2026-10-01T09:12:30Z",
"updated_at": "2026-10-14T16:40:03Z"
}

Response Schema​

The renamed bank account, with the fields of a List Bank Accounts row.

Errors​

StatusmessageWhen
400failed to parse requestThe body is not valid JSON, or bank_account_id is not a bnk_… id.
400invalid_bank_account_namename is only spaces, or longer than 60 characters.
401unauthorizedMissing or invalid signature.
404bank_account_not_foundNo such bank account, or it belongs to another account.
422Validation failedname is missing or empty; details names it.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!