au.org.consumerdatastandards.client.api

Class BankingAccountsAPI

java.lang.Object

au.org.consumerdatastandards.client.api.BankingAccountsAPI

public class BankingAccountsAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
BankingAccountsAPI()
BankingAccountsAPI(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ResponseBankingAccountById	getAccountDetail(String accountId) Get Account Detail Obtain detailed information on a single account
okhttp3.Call	getAccountDetailAsync(String accountId, ApiCallback<ResponseBankingAccountById> _callback) Get Account Detail (asynchronously) Obtain detailed information on a single account
okhttp3.Call	getAccountDetailCall(String accountId, ApiCallback _callback) Build call for getAccountDetail
ApiResponse<ResponseBankingAccountById>	getAccountDetailWithHttpInfo(String accountId) Get Account Detail Obtain detailed information on a single account
ApiClient	getApiClient()
ResponseBankingTransactionById	getTransactionDetail(String accountId, String transactionId) Get Transaction Detail Obtain detailed information on a transaction for a specific account
okhttp3.Call	getTransactionDetailAsync(String accountId, String transactionId, ApiCallback<ResponseBankingTransactionById> _callback) Get Transaction Detail (asynchronously) Obtain detailed information on a transaction for a specific account
okhttp3.Call	getTransactionDetailCall(String accountId, String transactionId, ApiCallback _callback) Build call for getTransactionDetail
ApiResponse<ResponseBankingTransactionById>	getTransactionDetailWithHttpInfo(String accountId, String transactionId) Get Transaction Detail Obtain detailed information on a transaction for a specific account
ResponseBankingTransactionList	getTransactions(String accountId, String maxAmount, String minAmount, java.time.OffsetDateTime newestTime, java.time.OffsetDateTime oldestTime, Integer page, Integer pageSize, String text) Get Transactions For Account Obtain transactions for a specific account.
okhttp3.Call	getTransactionsAsync(String accountId, String maxAmount, String minAmount, java.time.OffsetDateTime newestTime, java.time.OffsetDateTime oldestTime, Integer page, Integer pageSize, String text, ApiCallback<ResponseBankingTransactionList> _callback) Get Transactions For Account (asynchronously) Obtain transactions for a specific account.
okhttp3.Call	getTransactionsCall(String accountId, String maxAmount, String minAmount, java.time.OffsetDateTime newestTime, java.time.OffsetDateTime oldestTime, Integer page, Integer pageSize, String text, ApiCallback _callback) Build call for getTransactions
ApiResponse<ResponseBankingTransactionList>	getTransactionsWithHttpInfo(String accountId, String maxAmount, String minAmount, java.time.OffsetDateTime newestTime, java.time.OffsetDateTime oldestTime, Integer page, Integer pageSize, String text) Get Transactions For Account Obtain transactions for a specific account.
ResponseBankingAccountList	listAccounts(Boolean isOwned, ParamAccountOpenStatus openStatus, Integer page, Integer pageSize, ParamProductCategory productCategory) Get Accounts Obtain a list of accounts
okhttp3.Call	listAccountsAsync(Boolean isOwned, ParamAccountOpenStatus openStatus, Integer page, Integer pageSize, ParamProductCategory productCategory, ApiCallback<ResponseBankingAccountList> _callback) Get Accounts (asynchronously) Obtain a list of accounts
okhttp3.Call	listAccountsCall(Boolean isOwned, ParamAccountOpenStatus openStatus, Integer page, Integer pageSize, ParamProductCategory productCategory, ApiCallback _callback) Build call for listAccounts
ApiResponse<ResponseBankingAccountList>	listAccountsWithHttpInfo(Boolean isOwned, ParamAccountOpenStatus openStatus, Integer page, Integer pageSize, ParamProductCategory productCategory) Get Accounts Obtain a list of accounts
ResponseBankingAccountsBalanceById	listBalance(String accountId) Get Account Balance Obtain the balance for a single specified account
okhttp3.Call	listBalanceAsync(String accountId, ApiCallback<ResponseBankingAccountsBalanceById> _callback) Get Account Balance (asynchronously) Obtain the balance for a single specified account
okhttp3.Call	listBalanceCall(String accountId, ApiCallback _callback) Build call for listBalance
ResponseBankingAccountsBalanceList	listBalancesSpecificAccounts(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Balances For Specific Accounts Obtain balances for a specified list of accounts
okhttp3.Call	listBalancesSpecificAccountsAsync(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback<ResponseBankingAccountsBalanceList> _callback) Get Balances For Specific Accounts (asynchronously) Obtain balances for a specified list of accounts
okhttp3.Call	listBalancesSpecificAccountsCall(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback _callback) Build call for listBalancesSpecificAccounts
ApiResponse<ResponseBankingAccountsBalanceList>	listBalancesSpecificAccountsWithHttpInfo(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Balances For Specific Accounts Obtain balances for a specified list of accounts
ApiResponse<ResponseBankingAccountsBalanceById>	listBalanceWithHttpInfo(String accountId) Get Account Balance Obtain the balance for a single specified account
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BankingAccountsAPI

public BankingAccountsAPI()

BankingAccountsAPI

public BankingAccountsAPI(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountDetailCall

public okhttp3.Call getAccountDetailCall(String accountId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getAccountDetail

Parameters:

accountId - A tokenised identifier for the account which is unique but not shareable (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getAccountDetail

public ResponseBankingAccountById getAccountDetail(String accountId)
                                            throws ApiException

Get Account Detail Obtain detailed information on a single account

Parameters:

accountId - A tokenised identifier for the account which is unique but not shareable (required)

Returns:

ResponseBankingAccountById

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getAccountDetailWithHttpInfo

public ApiResponse<ResponseBankingAccountById> getAccountDetailWithHttpInfo(String accountId)
                                                                     throws ApiException

Get Account Detail Obtain detailed information on a single account

Parameters:

accountId - A tokenised identifier for the account which is unique but not shareable (required)

Returns:

ApiResponse<ResponseBankingAccountById>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getAccountDetailAsync

public okhttp3.Call getAccountDetailAsync(String accountId,
                                          ApiCallback<ResponseBankingAccountById> _callback)
                                   throws ApiException

Get Account Detail (asynchronously) Obtain detailed information on a single account

Parameters:

accountId - A tokenised identifier for the account which is unique but not shareable (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionDetailCall

public okhttp3.Call getTransactionDetailCall(String accountId,
                                             String transactionId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getTransactionDetail

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points (required)

transactionId - ID of the transaction obtained from a previous call to one of the other transaction end points (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionDetail

public ResponseBankingTransactionById getTransactionDetail(String accountId,
                                                           String transactionId)
                                                    throws ApiException

Get Transaction Detail Obtain detailed information on a transaction for a specific account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points (required)

transactionId - ID of the transaction obtained from a previous call to one of the other transaction end points (required)

Returns:

ResponseBankingTransactionById

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionDetailWithHttpInfo

public ApiResponse<ResponseBankingTransactionById> getTransactionDetailWithHttpInfo(String accountId,
                                                                                    String transactionId)
                                                                             throws ApiException

Get Transaction Detail Obtain detailed information on a transaction for a specific account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points (required)

transactionId - ID of the transaction obtained from a previous call to one of the other transaction end points (required)

Returns:

ApiResponse<ResponseBankingTransactionById>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionDetailAsync

public okhttp3.Call getTransactionDetailAsync(String accountId,
                                              String transactionId,
                                              ApiCallback<ResponseBankingTransactionById> _callback)
                                       throws ApiException

Get Transaction Detail (asynchronously) Obtain detailed information on a transaction for a specific account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points (required)

transactionId - ID of the transaction obtained from a previous call to one of the other transaction end points (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionsCall

public okhttp3.Call getTransactionsCall(String accountId,
                                        String maxAmount,
                                        String minAmount,
                                        java.time.OffsetDateTime newestTime,
                                        java.time.OffsetDateTime oldestTime,
                                        Integer page,
                                        Integer pageSize,
                                        String text,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getTransactions

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points. (required)

maxAmount - Filter transactions to only transactions with amounts less than or equal to than this amount (optional)

minAmount - Filter transactions to only transactions with amounts higher or equal to than this amount (optional)

newestTime - Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type (optional)

oldestTime - Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

text - Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactions

public ResponseBankingTransactionList getTransactions(String accountId,
                                                      String maxAmount,
                                                      String minAmount,
                                                      java.time.OffsetDateTime newestTime,
                                                      java.time.OffsetDateTime oldestTime,
                                                      Integer page,
                                                      Integer pageSize,
                                                      String text)
                                               throws ApiException

Get Transactions For Account Obtain transactions for a specific account. Some general notes that apply to all end points that retrieve transactions: - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the “effective” date/time which will be defined as: - Posted date/time if available, then - Execution date/time if available, then - A reasonable date/time nominated by the data holder using internal data structures - For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points. (required)

maxAmount - Filter transactions to only transactions with amounts less than or equal to than this amount (optional)

minAmount - Filter transactions to only transactions with amounts higher or equal to than this amount (optional)

newestTime - Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type (optional)

oldestTime - Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

text - Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied (optional)

Returns:

ResponseBankingTransactionList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionsWithHttpInfo

public ApiResponse<ResponseBankingTransactionList> getTransactionsWithHttpInfo(String accountId,
                                                                               String maxAmount,
                                                                               String minAmount,
                                                                               java.time.OffsetDateTime newestTime,
                                                                               java.time.OffsetDateTime oldestTime,
                                                                               Integer page,
                                                                               Integer pageSize,
                                                                               String text)
                                                                        throws ApiException

Get Transactions For Account Obtain transactions for a specific account. Some general notes that apply to all end points that retrieve transactions: - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the “effective” date/time which will be defined as: - Posted date/time if available, then - Execution date/time if available, then - A reasonable date/time nominated by the data holder using internal data structures - For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points. (required)

maxAmount - Filter transactions to only transactions with amounts less than or equal to than this amount (optional)

minAmount - Filter transactions to only transactions with amounts higher or equal to than this amount (optional)

newestTime - Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type (optional)

oldestTime - Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

text - Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied (optional)

Returns:

ApiResponse<ResponseBankingTransactionList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

getTransactionsAsync

public okhttp3.Call getTransactionsAsync(String accountId,
                                         String maxAmount,
                                         String minAmount,
                                         java.time.OffsetDateTime newestTime,
                                         java.time.OffsetDateTime oldestTime,
                                         Integer page,
                                         Integer pageSize,
                                         String text,
                                         ApiCallback<ResponseBankingTransactionList> _callback)
                                  throws ApiException

Get Transactions For Account (asynchronously) Obtain transactions for a specific account. Some general notes that apply to all end points that retrieve transactions: - Where multiple transactions are returned, transactions should be ordered according to effective date in descending order - As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the “effective” date/time which will be defined as: - Posted date/time if available, then - Execution date/time if available, then - A reasonable date/time nominated by the data holder using internal data structures - For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account

Parameters:

accountId - ID of the account to get transactions for. Must have previously been returned by one of the account list end points. (required)

maxAmount - Filter transactions to only transactions with amounts less than or equal to than this amount (optional)

minAmount - Filter transactions to only transactions with amounts higher or equal to than this amount (optional)

newestTime - Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString common type (optional)

oldestTime - Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to newest-time minus 90 days. Format is aligned to DateTimeString common type (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

text - Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listAccountsCall

public okhttp3.Call listAccountsCall(Boolean isOwned,
                                     ParamAccountOpenStatus openStatus,
                                     Integer page,
                                     Integer pageSize,
                                     ParamProductCategory productCategory,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listAccounts

Parameters:

isOwned - Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)

openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

productCategory - Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listAccounts

public ResponseBankingAccountList listAccounts(Boolean isOwned,
                                               ParamAccountOpenStatus openStatus,
                                               Integer page,
                                               Integer pageSize,
                                               ParamProductCategory productCategory)
                                        throws ApiException

Get Accounts Obtain a list of accounts

Parameters:

isOwned - Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)

openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

productCategory - Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. (optional)

Returns:

ResponseBankingAccountList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listAccountsWithHttpInfo

public ApiResponse<ResponseBankingAccountList> listAccountsWithHttpInfo(Boolean isOwned,
                                                                        ParamAccountOpenStatus openStatus,
                                                                        Integer page,
                                                                        Integer pageSize,
                                                                        ParamProductCategory productCategory)
                                                                 throws ApiException

Get Accounts Obtain a list of accounts

Parameters:

isOwned - Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)

openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

productCategory - Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. (optional)

Returns:

ApiResponse<ResponseBankingAccountList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listAccountsAsync

public okhttp3.Call listAccountsAsync(Boolean isOwned,
                                      ParamAccountOpenStatus openStatus,
                                      Integer page,
                                      Integer pageSize,
                                      ParamProductCategory productCategory,
                                      ApiCallback<ResponseBankingAccountList> _callback)
                               throws ApiException

Get Accounts (asynchronously) Obtain a list of accounts

Parameters:

isOwned - Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)

openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

productCategory - Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listBalanceCall

public okhttp3.Call listBalanceCall(String accountId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for listBalance

Parameters:

accountId - ID of the specific account requested (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listBalance

public ResponseBankingAccountsBalanceById listBalance(String accountId)
                                               throws ApiException

Get Account Balance Obtain the balance for a single specified account

Parameters:

accountId - ID of the specific account requested (required)

Returns:

ResponseBankingAccountsBalanceById

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listBalanceWithHttpInfo

public ApiResponse<ResponseBankingAccountsBalanceById> listBalanceWithHttpInfo(String accountId)
                                                                        throws ApiException

Get Account Balance Obtain the balance for a single specified account

Parameters:

accountId - ID of the specific account requested (required)

Returns:

ApiResponse<ResponseBankingAccountsBalanceById>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listBalanceAsync

public okhttp3.Call listBalanceAsync(String accountId,
                                     ApiCallback<ResponseBankingAccountsBalanceById> _callback)
                              throws ApiException

Get Account Balance (asynchronously) Obtain the balance for a single specified account

Parameters:

accountId - ID of the specific account requested (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listBalancesSpecificAccountsCall

public okhttp3.Call listBalancesSpecificAccountsCall(RequestAccountIds accountIds,
                                                     Integer page,
                                                     Integer pageSize,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for listBalancesSpecificAccounts

Parameters:

accountIds - The list of account IDs to obtain balances for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listBalancesSpecificAccounts

public ResponseBankingAccountsBalanceList listBalancesSpecificAccounts(RequestAccountIds accountIds,
                                                                       Integer page,
                                                                       Integer pageSize)
                                                                throws ApiException

Get Balances For Specific Accounts Obtain balances for a specified list of accounts

Parameters:

accountIds - The list of account IDs to obtain balances for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ResponseBankingAccountsBalanceList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listBalancesSpecificAccountsWithHttpInfo

public ApiResponse<ResponseBankingAccountsBalanceList> listBalancesSpecificAccountsWithHttpInfo(RequestAccountIds accountIds,
                                                                                                Integer page,
                                                                                                Integer pageSize)
                                                                                         throws ApiException

Get Balances For Specific Accounts Obtain balances for a specified list of accounts

Parameters:

accountIds - The list of account IDs to obtain balances for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ApiResponse<ResponseBankingAccountsBalanceList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listBalancesSpecificAccountsAsync

public okhttp3.Call listBalancesSpecificAccountsAsync(RequestAccountIds accountIds,
                                                      Integer page,
                                                      Integer pageSize,
                                                      ApiCallback<ResponseBankingAccountsBalanceList> _callback)
                                               throws ApiException

Get Balances For Specific Accounts (asynchronously) Obtain balances for a specified list of accounts

Parameters:

accountIds - The list of account IDs to obtain balances for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-