bank-accounts.md

Bank Accounts

const bankAccountsApi = client.bankAccountsApi;

Class Name

BankAccountsApi

Methods

• List Bank Accounts
• Get Bank Account by V1 Id
• Get Bank Account

List Bank Accounts

Returns a list of BankAccount objects linked to a Square account.

async listBankAccounts(
  cursor?: string,
  limit?: number,
  locationId?: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<ListBankAccountsResponse>>

Parameters

Parameter	Type	Tags	Description
cursor	string | undefined	Query, Optional	The pagination cursor returned by a previous call to this endpoint. Use it in the next ListBankAccounts request to retrieve the next set of results. See the Pagination guide for more information.
limit	number | undefined	Query, Optional	Upper limit on the number of bank accounts to return in the response. Currently, 1000 is the largest supported limit. You can specify a limit of up to 1000 bank accounts. This is also the default limit.
locationId	string | undefined	Query, Optional	Location ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific location.
requestOptions	RequestOptions | undefined	Optional	Pass additional request options.

Response Type

ListBankAccountsResponse

Example Usage

try {
  const { result, ...httpResponse } = await bankAccountsApi.listBankAccounts();
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Get Bank Account by V1 Id

Returns details of a BankAccount identified by V1 bank account ID.

async getBankAccountByV1Id(
  v1BankAccountId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetBankAccountByV1IdResponse>>

Parameters

Parameter	Type	Tags	Description
v1BankAccountId	string	Template, Required	Connect V1 ID of the desired BankAccount. For more information, see Retrieve a bank account by using an ID issued by V1 Bank Accounts API.
requestOptions	RequestOptions | undefined	Optional	Pass additional request options.

Response Type

GetBankAccountByV1IdResponse

Example Usage

const v1BankAccountId = 'v1_bank_account_id8';
try {
  const { result, ...httpResponse } = await bankAccountsApi.getBankAccountByV1Id(v1BankAccountId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Get Bank Account

Returns details of a BankAccount linked to a Square account.

async getBankAccount(
  bankAccountId: string,
  requestOptions?: RequestOptions
): Promise<ApiResponse<GetBankAccountResponse>>

Parameters

Parameter	Type	Tags	Description
bankAccountId	string	Template, Required	Square-issued ID of the desired BankAccount.
requestOptions	RequestOptions | undefined	Optional	Pass additional request options.

Response Type

GetBankAccountResponse

Example Usage

const bankAccountId = 'bank_account_id0';
try {
  const { result, ...httpResponse } = await bankAccountsApi.getBankAccount(bankAccountId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch(error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}