Docs API Reference Bank Account/bff/bank-account/{externalId}/update

/bff/bank-account/{externalId}/update

Partial-update of organisation-scoped, user-editable fields on a bank account. Currently exposes displayName. Designed to grow safely: unspecified fields are left untouched, null / "" clears the value.

Bank accountpostBffBank-accountByExternalIdUpdate

Parameters

1 path · JSON body

Path parameters

· 1

externalIdstringRequired

Bank account external ID returned by the list endpoint.

Exampleexample_externalId

Request body

application/json

displayNamestring | nullOptional

Custom user-facing label for the account. Empty string or null clears it (the UI will then fall back to domesticLabel / IBAN / external ID).

One of 2:

Variant 1

string

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Response example

application/json

{
  "success": false
}

Request example

POST /bff/bank-account/{externalId}/update

post

curl -X POST "https://api.bizkithub.com/bff/bank-account/example_externalId/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key