com.squareup.square.api

Interface BankAccountsApi

All Known Implementing Classes:

DefaultBankAccountsApi

public interface BankAccountsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

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.

Method Detail

listBankAccounts

ListBankAccountsResponse listBankAccounts(String cursor,
                                          Integer limit,
                                          String locationId)
                                   throws ApiException,
                                          IOException

Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.

Parameters:

cursor - 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.

Returns:

Returns the ListBankAccountsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listBankAccountsAsync

CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(String cursor,
                                                                  Integer limit,
                                                                  String locationId)

Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square account.

Parameters:

cursor - 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.

Returns:

Returns the ListBankAccountsResponse response from the API call

getBankAccountByV1Id

GetBankAccountByV1IdResponse getBankAccountByV1Id(String v1BankAccountId)
                                           throws ApiException,
                                                  IOException

Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.

Parameters:

v1BankAccountId - 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).

Returns:

Returns the GetBankAccountByV1IdResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getBankAccountByV1IdAsync

CompletableFuture<GetBankAccountByV1IdResponse> getBankAccountByV1IdAsync(String v1BankAccountId)

Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.

Parameters:

v1BankAccountId - 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).

Returns:

Returns the GetBankAccountByV1IdResponse response from the API call

getBankAccount

GetBankAccountResponse getBankAccount(String bankAccountId)
                               throws ApiException,
                                      IOException

Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.

Parameters:

bankAccountId - Required parameter: Square-issued ID of the desired `BankAccount`.

Returns:

Returns the GetBankAccountResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getBankAccountAsync

CompletableFuture<GetBankAccountResponse> getBankAccountAsync(String bankAccountId)

Returns details of a [BankAccount]($m/BankAccount) linked to a Square account.

Parameters:

bankAccountId - Required parameter: Square-issued ID of the desired `BankAccount`.

Returns:

Returns the GetBankAccountResponse response from the API call