KintsugiKintsugi

Update bank details

PATCH/bank-details

Partial update of the organization's bank details. Fields you omit keep their stored value; a field sent as null is cleared. An empty body changes nothing: it returns the stored record, or null when none exists. Otherwise creates the record when none exists, for a country that needs no mandate. This route refuses to create an account in a mandate country or change the country to one. Use POST /bank-details with mandateCopyId. Optional makePrimary makes the account this route updates the organization's debit account (Owner or Admin only; an Api-Key and an impersonated session are refused). To choose a different account by id, send isPrimary on PATCH /bank-details/{bank_details_id} (an API key may send that flag). The response masks the account and routing numbers to their last four characters. Admin or Owner only for a user credential; an API key is permitted for field updates. The organization is selected by Organization-Id, Connection-Id, or Entity-Id.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

bankNamestring

Name of the bank. Send null to clear it.

accountNumberstring

Bank account number. Send null to clear it.

accountTypePublicBankAccountTypeEnum

Account type. Send null to clear it.

Available options:CHECKINGSAVINGS
accountHolderNamestring

Name on the account. Send null to clear it.

accountHolderTypePublicBankAccountHolderTypeEnum

Whether the account belongs to an individual or a business. Send null to clear it.

Available options:INDIVIDUALBUSINESS
routingNumberstring

Bank routing number. Send null to clear it.

makePrimaryboolean

When true, makes this account the organization's debit account. Owner or Admin only; not permitted with an Api-Key.

Response

idstringRequired

Opaque identifier of the bank-details record.

bankNamestringRequired

Name of the bank, or null when not captured.

accountNumberLast4stringRequired

Last four characters of the account number, or null when not captured.

accountTypePublicBankAccountTypeEnumRequired

Account type, or null when not captured.

Available options:CHECKINGSAVINGS
accountHolderNamestringRequired

Name on the account, or null when not captured.

accountHolderTypePublicBankAccountHolderTypeEnumRequired

Whether the account belongs to an individual or a business, or null when not captured.

Available options:INDIVIDUALBUSINESS
routingNumberLast4stringRequired

Last four characters of the routing number, or null when not captured.

countrySpecificFieldsCanadaBankFieldsMasked | UkBankFieldsMasked | SepaBankFieldsMasked | AustraliaBankFieldsMasked | NewZealandBankFieldsMasked | MexicoBankFieldsMasked | UsBankFieldsMaskedRequired

The account's own identifiers, each masked to its last four characters, or null when none are captured yet.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

503

The server cannot save bank details right now. Another save of the account may still be running, or the sign-in provider could not confirm the user's role for mandateCopyId. Retry after the Retry-After header when present, and contact support if it persists.

cURL
PATCH /bank-details
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"bankName": "First National Bank",
"accountNumber": "000123456789",
"accountType": "CHECKING",
"accountHolderName": "Acme, Inc.",
"accountHolderType": "INDIVIDUAL",
"routingNumber": "110000000",
"makePrimary": false
}
Response
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"bankName": "First National Bank",
"accountNumberLast4": "6789",
"accountType": "CHECKING",
"accountHolderName": "Acme, Inc.",
"accountHolderType": "INDIVIDUAL",
"routingNumberLast4": "0000",
"countrySpecificFields": {
"type": "CA",
"institutionNumberLast4": "institution number last4",
"transitNumberLast4": "transit number last4",
"accountNumberLast4": "account number last4"
}
}
Update bank details (2026-07-21) | Kintsugi API Reference