Customer bank accounts
Account at a bank that a customer holds, used for payouts and refunds.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Customer | customerId | Reference | Yes | |
| Name | label | Text | Yes | |
| Account holder | holderName | Text | Yes | |
| Bank | bank | Text | Yes | |
| Account currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Account number | accountNumber | Text | ||
| Bank identifier type | bankIdentifierScheme | Constant | Fixed option from the allowed set for this field. | |
| Bank identifier | bankIdentifier | Text | ||
| IBAN | iban | Text | ||
| SWIFT | swift | Text | ||
| ABA | aba | Text | ||
| Default | isDefault | Boolean | Yes | When enabled, this row is the default choice among peers. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
Actions
What you can do with a record. Every action also sends the webhook event customerbankaccounts.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new bank account. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this bank account. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this bank account. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this bank account again. | App · API · CLI |
| Archive | archive | Retire this bank account from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this bank account to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this bank account and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |