QuickBooks: Create a bank account

← payments_bankaccounts operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.payments.bankaccounts.create_a_bank_account

Provider route: POST /quickbooks/v4/customers/{id}/bank-accounts. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["paymentsBankaccounts"]["create"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.paymentsBankaccounts.create(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments_bankaccounts.create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Minimum length: 1
headers	object	Required within parent	Additional keys: not allowed
headers.request-Id	string	Required within parent	The request-Id that uniquely identifies the HTTP request sent by your app to the server. This lets apps correlate requests and responses in case it needs to resend a request due to a dropped connection. Maximum length: 50
body	object	Required within parent	Additional keys: not allowed
body.accountNumber	string	Required within parent	The bank account number to be used. For security purposes, only the last four digits are displayed.
body.accountType	string	Required within parent	The type of account to be used. Valid values include: PERSONAL_CHECKING the account is a personal checking account. PERSONAL_SAVINGS the account is a personal savings account. BUSINESS_CHECKING the account is a business checking account. BUSINESS_SAVINGS the account is a business savings account.
body.bankCode	string	Optional	A code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions. Varies depending on country.
body.country	string	Optional	ISO-standard country code. Refer to Country Code List for a list of codes.
body.created	string	Optional	The time the object was originally created. In ISO 8601 date-time format. It appears as YYYY-MM-DDTHH:MM:SSZ . Read only: true
body.default	JSON	Optional	A flag to indicate whether the account is the default, which will be used when one is not explicitly specified. The flag defaults to false ; when one account is flagged as true, all other stored accounts in the collection will automatically be set to false.
body.default (anyOf 1)	boolean	Alternative
body.default (anyOf 2)	string	Alternative	One of: true, false
body.id	string	Optional	The unique identifier of a bank account object. The id is required for update or delete operations. Conditionally required
body.inputType	string	Optional	Specifies the input type. Valid values include: KEYED A manually-entered account key.
body.name	string	Required within parent	The name of the bank account holder.
body.phone	string	Required within parent	A phone number to be associated with the account.
body.routingNumber	string	Required within parent	The bank routing number. For security purposes, only the last four digits are displayed.
body.updated	string	Optional	The time the object was last updated. In ISO 8601 date-time format. It appears as YYYY-MM-DDTHH:MM:SSZ . Conditionally required Read only: true
body.entityId	string	Optional	The ID of the entity the bank account is associated with.
body.entityType	string	Optional	The entity or user type the bank account is associated with. Example values: Customer , Employee , Vendor or Company

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a bank account — response body

Referenced models: Create a bank account — response body

Policy, approvals and errors

SDK function policy ID: quickbooks.payments.bankaccounts.create_a_bank_account. Catalog operation: payments/bankaccounts/create_a_bank_account. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source