Rename financial account

Rename Financial Account

The Rename Financial Account endpoint allows authenticated users to update the display name of an existing financial account within their profile. By supplying the account's unique identifier and a new name, users can personalize or reorganize their accounts for easier identification. The response confirms whether the renaming operation was successful.

Endpoint

POST /api/financialAccounts/rename

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a customer needs to update the label on one of their financial accounts to better reflect its purpose or improve organization. This is useful for both personal and business customers who manage multiple accounts and want meaningful, descriptive names for each. It can also be used to correct a name set during account creation.

Request Body

FieldTypeRequiredDescription
financialAccountIdstringYesThe unique identifier of the financial account to rename. Minimum length: 1 character.
namestringYesThe new display name for the financial account. Minimum length: 1 character, maximum length: 128 characters.
{
  "financialAccountId": "fa_8d3f2a1b4c9e7d6f",
  "name": "Operating Expenses"
}

Response

200 OK

A 200 response confirms the financial account was successfully renamed. The response body confirms the operation succeeded.

{}

Error Codes

CodeWhen it happens
400Missing required fields (financialAccountId or name), or field validation failure (e.g., name exceeds 128 characters)
401Token missing, expired, or invalid
403Insufficient permissions — the authenticated user does not have access to the specified account
404Financial account not found for the provided financialAccountId
500Internal server error

Common Mistakes

  • Omitting financialAccountId — both fields are required; the request will return a 400 error if either is missing.
  • Providing a name value that exceeds 128 characters — the schema enforces a maximum length and the request will be rejected.
  • Using an expired or missing Bearer token — tokens are valid for only 10 minutes; refresh before making the request if necessary.
  • Attempting to rename an account that belongs to a different customer — the token scope restricts access to the authenticated user's accounts only.

Related Endpoints

  • POST /api/financialAccounts — Create a new financial account
  • GET /api/financialAccounts — Retrieve a list of financial accounts for the authenticated user
  • GET /api/financialAccounts/{financialAccountId} — Retrieve details for a specific financial account

Example

curl -X POST https://api.banking.netevia.dev/api/financialAccounts/rename \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "financialAccountId": "fa_8d3f2a1b4c9e7d6f",
    "name": "Operating Expenses"
  }'
Body Params
string
required
length ≥ 1
string
required
length between 1 and 128
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!