Update Bank Account

PATCH /banking/bank-accounts/{id}

Group: Banking › Bank Accounts · Operation ID: updateBankAccount

Updates the bank account with the given identifier. Only the fields in the request body change.

Every field is optional and omitting it leaves the stored value unchanged. The response is empty. Read the result with GET banking/bank-accounts/:id.

reconciliationStartDate and paymentAllowed are set when the account is created and cannot be changed here.

When referenceType is 'QRR', the QR-IBAN check runs against the incoming reference when one is sent and against the stored reference otherwise, and a failure is INVALID_QR_IBAN.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the bank account to update.

Request body

Required, application/json: updateBankAccountInput.

Field Type Required Description
externalAccountId string no The account's identifier in the system that owns it, for example its IBAN or ACH account number. Must be unique within the tenant. Omit to leave unchanged. The account's own current value is not a collision.
accountId string no The general-ledger account this bank account posts to. Omit to leave unchanged. See id on GET accounting/accounts/:id.
financialInstitutionId string no The financial institution holding the account. Omit to leave unchanged. There is no endpoint for it.
currency string no The account currency. Format ISO 4217, for example 'USD'. Omit to leave unchanged.
type string no The kind of account, as free-form text. For example 'checking' or 'saving'. Omit to leave unchanged.
reference string no The IBAN or ACH account number. When referenceType is 'QRR' this must be a Swiss QR-IBAN. Omit to leave unchanged.
referenceType string no How payment references on this account are structured. Accepted values: 'QRR', 'SCOR', 'NON'. Omit to leave unchanged.
referenceNumber string no A structured creditor reference number for this account. Omit to leave unchanged.
receivableAccount boolean no Whether the account may receive incoming payments. Omit to leave unchanged.

Example:

{
  "externalAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "financialInstitutionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "<currency>",
  "type": "savings",
  "reference": "<reference>",
  "referenceType": "NON",
  "referenceNumber": "<referenceNumber>",
  "receivableAccount": true
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
REFERENCE_NOT_FOUND 400
INVALID_FIELD_VALUE 400
INVALID_QR_IBAN 400
DUPLICATE_EXTERNAL_ACCOUNT_ID 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses