Skip to content
    Docs
    Oblax Modules
    Identity
    Bank Account

    Bank Account

    A Bank Account represents a financial institution account owned by an organization. Bank accounts store routing and account identification details and are used for payouts, billing, or invoice settlements. A single bank account can be designated as the primary account for its owner organization, which updates the organization’s primary_bank_account_id pointer.

    Sample Object 

    {
  "id": "bnk_678stu901vwx",
  "owner_id": "org_abc123def456",
  "account_number": "1234567890",
  "bic": "BOFAUS3N",
  "iban": "US12345678901234567890",
  "currency": "USD"
}

    Fields

    FieldTypeDescription
    idstringUnique identifier for the bank account. Auto-generated on create.
    owner_idstringID of the organization that owns this bank account.
    account_numberstringFinancial institution account number.
    bicstringBank Identifier Code (SWIFT BIC).
    ibanstringInternational Bank Account Number.
    currencystringAccount currency. ISO 4217 format.
    primarybooleanWhen set to true on create or update, this bank account becomes the organization’s primary bank account.

    Actions

    Adding a bank account to an organization

    Adds a new bank account to an organization. When the primary flag is set to true, the organization’s primary_bank_account_id is updated.

    obx app identity:organizations:bank-accounts init
obx app identity:organizations:bank-accounts push init --org-id org_abc123def456

    Listing an organization’s bank accounts

    Returns all bank accounts owned by a specific organization.

    obx app identity:organizations:bank-accounts list --org-id org_abc123def456

    Getting an organization’s bank account

    Returns a specific bank account by its ID within the context of the organization owner.

    obx app identity:organizations:bank-accounts pull bnk_678stu901vwx --org-id org_abc123def456

    Updating an organization’s bank account

    Updates the fields of a bank account. Set primary to true to promote this account as the organization’s primary bank account.

    obx app identity:organizations:bank-accounts push bnk_678stu901vwx --org-id org_abc123def456

    Deleting an organization’s bank account

    Removes a bank account from the organization. If the deleted account was the primary bank account, the organization’s primary_bank_account_id is set to null.

    obx app identity:organizations:bank-accounts delete bnk_678stu901vwx --org-id org_abc123def456

    Deleting all of an organization’s bank accounts

    Removes every bank account owned by the organization in a single operation.

    obx app identity:organizations:bank-accounts delete-all --org-id org_abc123def456
    RoleOrganization Person