au.org.consumerdatastandards.client.api

Class BankingScheduledPaymentsAPI

java.lang.Object

au.org.consumerdatastandards.client.api.BankingScheduledPaymentsAPI

public class BankingScheduledPaymentsAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
BankingScheduledPaymentsAPI()
BankingScheduledPaymentsAPI(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ResponseBankingScheduledPaymentsList	listScheduledPayments(String accountId, Integer page, Integer pageSize) Get Scheduled Payments for Account Obtain scheduled, outgoing payments for a specific account
okhttp3.Call	listScheduledPaymentsAsync(String accountId, Integer page, Integer pageSize, ApiCallback<ResponseBankingScheduledPaymentsList> _callback) Get Scheduled Payments for Account (asynchronously) Obtain scheduled, outgoing payments for a specific account
okhttp3.Call	listScheduledPaymentsCall(String accountId, Integer page, Integer pageSize, ApiCallback _callback) Build call for listScheduledPayments
ResponseBankingScheduledPaymentsList	listScheduledPaymentsSpecificAccounts(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Scheduled Payments For Specific Accounts Obtain scheduled payments for a specified list of accounts
okhttp3.Call	listScheduledPaymentsSpecificAccountsAsync(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback<ResponseBankingScheduledPaymentsList> _callback) Get Scheduled Payments For Specific Accounts (asynchronously) Obtain scheduled payments for a specified list of accounts
okhttp3.Call	listScheduledPaymentsSpecificAccountsCall(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback _callback) Build call for listScheduledPaymentsSpecificAccounts
ApiResponse<ResponseBankingScheduledPaymentsList>	listScheduledPaymentsSpecificAccountsWithHttpInfo(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Scheduled Payments For Specific Accounts Obtain scheduled payments for a specified list of accounts
ApiResponse<ResponseBankingScheduledPaymentsList>	listScheduledPaymentsWithHttpInfo(String accountId, Integer page, Integer pageSize) Get Scheduled Payments for Account Obtain scheduled, outgoing payments for a specific 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

BankingScheduledPaymentsAPI

public BankingScheduledPaymentsAPI()

BankingScheduledPaymentsAPI

public BankingScheduledPaymentsAPI(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listScheduledPaymentsCall

public okhttp3.Call listScheduledPaymentsCall(String accountId,
                                              Integer page,
                                              Integer pageSize,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for listScheduledPayments

Parameters:

accountId - ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment (required)

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	-

listScheduledPayments

public ResponseBankingScheduledPaymentsList listScheduledPayments(String accountId,
                                                                  Integer page,
                                                                  Integer pageSize)
                                                           throws ApiException

Get Scheduled Payments for Account Obtain scheduled, outgoing payments for a specific account

Parameters:

accountId - ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment (required)

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:

ResponseBankingScheduledPaymentsList

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	-

listScheduledPaymentsWithHttpInfo

public ApiResponse<ResponseBankingScheduledPaymentsList> listScheduledPaymentsWithHttpInfo(String accountId,
                                                                                           Integer page,
                                                                                           Integer pageSize)
                                                                                    throws ApiException

Get Scheduled Payments for Account Obtain scheduled, outgoing payments for a specific account

Parameters:

accountId - ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment (required)

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<ResponseBankingScheduledPaymentsList>

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	-

listScheduledPaymentsAsync

public okhttp3.Call listScheduledPaymentsAsync(String accountId,
                                               Integer page,
                                               Integer pageSize,
                                               ApiCallback<ResponseBankingScheduledPaymentsList> _callback)
                                        throws ApiException

Get Scheduled Payments for Account (asynchronously) Obtain scheduled, outgoing payments for a specific account

Parameters:

accountId - ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment (required)

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	-

listScheduledPaymentsSpecificAccountsCall

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

Build call for listScheduledPaymentsSpecificAccounts

Parameters:

accountIds - Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned (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	-

listScheduledPaymentsSpecificAccounts

public ResponseBankingScheduledPaymentsList listScheduledPaymentsSpecificAccounts(RequestAccountIds accountIds,
                                                                                  Integer page,
                                                                                  Integer pageSize)
                                                                           throws ApiException

Get Scheduled Payments For Specific Accounts Obtain scheduled payments for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned (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:

ResponseBankingScheduledPaymentsList

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	-

listScheduledPaymentsSpecificAccountsWithHttpInfo

public ApiResponse<ResponseBankingScheduledPaymentsList> listScheduledPaymentsSpecificAccountsWithHttpInfo(RequestAccountIds accountIds,
                                                                                                           Integer page,
                                                                                                           Integer pageSize)
                                                                                                    throws ApiException

Get Scheduled Payments For Specific Accounts Obtain scheduled payments for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned (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<ResponseBankingScheduledPaymentsList>

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	-

listScheduledPaymentsSpecificAccountsAsync

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

Get Scheduled Payments For Specific Accounts (asynchronously) Obtain scheduled payments for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned (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	-