QuickBooks: Create a bank account from a token

← payments_bankaccounts operations · Get started · OpenAPI downloads

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

Provider route: POST /quickbooks/v4/customers/{id}/bank-accounts/createFromToken. 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"]["createFromToken"]>[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.createFromToken(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_from_token(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	Optional	The number of the bank account. For privacy and security, Account numbers that are 6 digits or less: all but the last 2 digits are masked Account numbers that are 7 digits or longer: all but the last 4 digits are masked Account Number masking changes are available in Sandbox companies currently and will be available from July 11th, 2022 for Production companies.
body.accountType	string	Optional	The type of bank account. Valid values: PERSONAL_CHECKING : Use for personal checking accounts. PERSONAL_SAVINGS : Use for personal savings accounts. BUSINESS_CHECKING : Use for business checking accounts. BUSINESS_SAVINGS : Use for business savings accounts.
body.bankCode	string	Optional	For US : This should also be the routing number for the bank associated with the account.
body.country	string	Optional	The ISO-standard country code. Refer to the ISO Country Code List . Maximum length: 2
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	Indicates if the bank account is the default. When users set a default, the account flag is true . This is the bank account QuickBooks uses when another isn’t specified. The flag defaults to false . When a bank account flag is true , all other stored bank accounts are automatically 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: KEYED : Indicates a manually-entered key. SCANNED
body.name	string	Optional	The name of the bank account owner. Maximum length: 64
body.phone	string	Optional	The phone number associated with the bank account.
body.routingNumber	string	Optional	The routing number for the bank associated with the account. For privacy and security, we only display the last four digits of the routing number.
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
body.value	string	Required within parent	The ID of the system generated token. Learn more about the token entity.

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_from_a_token. Catalog operation: payments/bankaccounts/create_a_bank_account_from_a_token. 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