public final class DefaultBankAccountsApi extends BaseApi implements BankAccountsApi
BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>authManagers, config, httpCallback, internalUserAgent| Constructor and Description |
|---|
DefaultBankAccountsApi(Configuration config,
HttpClient httpClient,
Map<String,AuthManager> authManagers)
Initializes the controller.
|
DefaultBankAccountsApi(Configuration config,
HttpClient httpClient,
Map<String,AuthManager> authManagers,
HttpCallback httpCallback)
Initializes the controller with HTTPCallback.
|
| Modifier and Type | Method and Description |
|---|---|
GetBankAccountResponse |
getBankAccount(String bankAccountId)
Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.
|
CompletableFuture<GetBankAccountResponse> |
getBankAccountAsync(String bankAccountId)
Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.
|
GetBankAccountByV1IdResponse |
getBankAccountByV1Id(String v1BankAccountId)
Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
|
CompletableFuture<GetBankAccountByV1IdResponse> |
getBankAccountByV1IdAsync(String v1BankAccountId)
Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
|
ListBankAccountsResponse |
listBankAccounts(String cursor,
Integer limit,
String locationId)
Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.
|
CompletableFuture<ListBankAccountsResponse> |
listBankAccountsAsync(String cursor,
Integer limit,
String locationId)
Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.
|
getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponsepublic DefaultBankAccountsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers)
config - Configurations added in client.httpClient - Send HTTP requests and read the responses.authManagers - Apply authorization to requests.public DefaultBankAccountsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback)
config - Configurations added in client.httpClient - Send HTTP requests and read the responses.authManagers - Apply authorization to requests.httpCallback - Callback to be called before and after the HTTP call.public ListBankAccountsResponse listBankAccounts(String cursor, Integer limit, String locationId) throws ApiException, IOException
listBankAccounts in interface BankAccountsApicursor - Optional parameter: 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](https://developer.squareup.com/docs/working-with-apis/pagination) guide
for more information.limit - Optional parameter: 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 - Optional parameter: Location ID. You can specify this optional filter to
retrieve only the linked bank accounts belonging to a specific location.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(String cursor, Integer limit, String locationId)
listBankAccountsAsync in interface BankAccountsApicursor - Optional parameter: 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](https://developer.squareup.com/docs/working-with-apis/pagination) guide
for more information.limit - Optional parameter: 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 - Optional parameter: Location ID. You can specify this optional filter to
retrieve only the linked bank accounts belonging to a specific location.public GetBankAccountByV1IdResponse getBankAccountByV1Id(String v1BankAccountId) throws ApiException, IOException
getBankAccountByV1Id in interface BankAccountsApiv1BankAccountId - Required parameter: 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](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<GetBankAccountByV1IdResponse> getBankAccountByV1IdAsync(String v1BankAccountId)
getBankAccountByV1IdAsync in interface BankAccountsApiv1BankAccountId - Required parameter: 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](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).public GetBankAccountResponse getBankAccount(String bankAccountId) throws ApiException, IOException
getBankAccount in interface BankAccountsApibankAccountId - Required parameter: Square-issued ID of the desired `BankAccount`.ApiException - Represents error response from the server.IOException - Signals that an I/O exception of some sort has occurred.public CompletableFuture<GetBankAccountResponse> getBankAccountAsync(String bankAccountId)
getBankAccountAsync in interface BankAccountsApibankAccountId - Required parameter: Square-issued ID of the desired `BankAccount`.Copyright © 2022. All rights reserved.