Package api

Class BalanceTransfersApi

java.lang.Object

api.BalanceTransfersApi

public class BalanceTransfersApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BalanceTransfersApi.APIlistBalanceTransfersRequest

Constructor Summary

Constructors

Constructor	Description
BalanceTransfersApi()
BalanceTransfersApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
BalanceTransfer	create(CreateBalanceTransferRequest createBalanceTransferRequest)	Create a Balance Transfer Create a `balance_transfer`.
okhttp3.Call	createBalanceTransferAsync(CreateBalanceTransferRequest createBalanceTransferRequest, ApiCallback<BalanceTransfer> _callback)	Create a Balance Transfer (asynchronously) Create a `balance_transfer`.
okhttp3.Call	createBalanceTransferCall(CreateBalanceTransferRequest createBalanceTransferRequest, ApiCallback _callback)	Build call for createBalanceTransfer
ApiResponse<BalanceTransfer>	createBalanceTransferWithHttpInfo(CreateBalanceTransferRequest createBalanceTransferRequest)	Create a Balance Transfer Create a `balance_transfer`.
BalanceTransfer	get(String balanceTransfersId)	Fetch a Balance Transfer Retrieve the details of a `balance_transfer`.
okhttp3.Call	getBalanceTransfersAsync(String balanceTransfersId, ApiCallback<BalanceTransfer> _callback)	Fetch a Balance Transfer (asynchronously) Retrieve the details of a `balance_transfer`.
okhttp3.Call	getBalanceTransfersCall(String balanceTransfersId, ApiCallback _callback)	Build call for getBalanceTransfers
ApiResponse<BalanceTransfer>	getBalanceTransfersWithHttpInfo(String balanceTransfersId)	Fetch a Balance Transfer Retrieve the details of a `balance_transfer`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
FinixList	list(ListBalanceTransfersQueryParams listBalanceTransfersQueryParams)	List Balance Transfers Retrieve a list of `balance_transfers`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

BalanceTransfersApi

public BalanceTransfersApi()

BalanceTransfersApi

public BalanceTransfersApi(FinixClient finixClient)

Method Detail

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createBalanceTransferCall

public okhttp3.Call createBalanceTransferCall(CreateBalanceTransferRequest createBalanceTransferRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createBalanceTransfer

Parameters:

createBalanceTransferRequest - (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
201	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

create

public BalanceTransfer create(CreateBalanceTransferRequest createBalanceTransferRequest)
                       throws ApiException

Create a Balance Transfer Create a `balance_transfer`.

Parameters:

createBalanceTransferRequest - (optional)

Returns:

BalanceTransfer

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
201	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createBalanceTransferWithHttpInfo

public ApiResponse<BalanceTransfer> createBalanceTransferWithHttpInfo(CreateBalanceTransferRequest createBalanceTransferRequest)
                                                               throws ApiException

Create a Balance Transfer Create a `balance_transfer`.

Parameters:

createBalanceTransferRequest - (optional)

Returns:

ApiResponse<BalanceTransfer>

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
201	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createBalanceTransferAsync

public okhttp3.Call createBalanceTransferAsync(CreateBalanceTransferRequest createBalanceTransferRequest,
                                               ApiCallback<BalanceTransfer> _callback)
                                        throws ApiException

Create a Balance Transfer (asynchronously) Create a `balance_transfer`.

Parameters:

createBalanceTransferRequest - (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
201	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getBalanceTransfersCall

public okhttp3.Call getBalanceTransfersCall(String balanceTransfersId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getBalanceTransfers

Parameters:

balanceTransfersId - ID of the `balance_transfer` resource. (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
200	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public BalanceTransfer get(String balanceTransfersId)
                    throws ApiException

Fetch a Balance Transfer Retrieve the details of a `balance_transfer`.

Parameters:

balanceTransfersId - ID of the `balance_transfer` resource. (required)

Returns:

BalanceTransfer

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
200	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getBalanceTransfersWithHttpInfo

public ApiResponse<BalanceTransfer> getBalanceTransfersWithHttpInfo(String balanceTransfersId)
                                                             throws ApiException

Fetch a Balance Transfer Retrieve the details of a `balance_transfer`.

Parameters:

balanceTransfersId - ID of the `balance_transfer` resource. (required)

Returns:

ApiResponse<BalanceTransfer>

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
200	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getBalanceTransfersAsync

public okhttp3.Call getBalanceTransfersAsync(String balanceTransfersId,
                                             ApiCallback<BalanceTransfer> _callback)
                                      throws ApiException

Fetch a Balance Transfer (asynchronously) Retrieve the details of a `balance_transfer`.

Parameters:

balanceTransfersId - ID of the `balance_transfer` resource. (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
200	Single balance_transfer object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListBalanceTransfersQueryParams listBalanceTransfersQueryParams)
               throws ApiException

List Balance Transfers Retrieve a list of `balance_transfers`.

Returns:

APIlistBalanceTransfersRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of balance_transfer objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Not Found	-
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -