Skip to content

Latest commit

 

History

History
132 lines (87 loc) · 3.91 KB

bank-accounts.md

File metadata and controls

132 lines (87 loc) · 3.91 KB
Raw

Bank Accounts

$bankAccountsApi = $client->getBankAccountsApi();

Class Name

BankAccountsApi

Methods

List Bank Accounts

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

function listBankAccounts(?string $cursor = null, ?int $limit = null, ?string $locationId = null): ApiResponse

Parameters

Parameter Type Tags Description
cursor ?string 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 ?int 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 Query, Optional Location ID. You can specify this optional filter
to retrieve only the linked bank accounts belonging to a specific location.

Response Type

ListBankAccountsResponse

Example Usage

$cursor = 'cursor6';
$limit = 172;
$locationId = 'location_id4';

$apiResponse = $bankAccountsApi->listBankAccounts($cursor, $limit, $locationId);

if ($apiResponse->isSuccess()) {
    $listBankAccountsResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Get Bank Account by V1 Id

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

function getBankAccountByV1Id(string $v1BankAccountId): ApiResponse

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.

Response Type

GetBankAccountByV1IdResponse

Example Usage

$v1BankAccountId = 'v1_bank_account_id8';

$apiResponse = $bankAccountsApi->getBankAccountByV1Id($v1BankAccountId);

if ($apiResponse->isSuccess()) {
    $getBankAccountByV1IdResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Get Bank Account

Returns details of a BankAccount linked to a Square account.

function getBankAccount(string $bankAccountId): ApiResponse

Parameters

Parameter Type Tags Description
bankAccountId string Template, Required Square-issued ID of the desired BankAccount.

Response Type

GetBankAccountResponse

Example Usage

$bankAccountId = 'bank_account_id0';

$apiResponse = $bankAccountsApi->getBankAccount($bankAccountId);

if ($apiResponse->isSuccess()) {
    $getBankAccountResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();