Package api

Class TransfersApi

java.lang.Object

api.TransfersApi

public class TransfersApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TransfersApi.APIlistTransferReversalsRequest
class	TransfersApi.APIlistTransfersRequest

Constructor Summary

Constructors

Constructor	Description
TransfersApi()
TransfersApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
Transfer	create(CreateTransferRequest createTransferRequest)	Create a Transfer Create a `Transfer`.
okhttp3.Call	createTransferAsync(CreateTransferRequest createTransferRequest, ApiCallback<Transfer> _callback)	Create a Transfer (asynchronously) Create a `Transfer`.
okhttp3.Call	createTransferCall(CreateTransferRequest createTransferRequest, ApiCallback _callback)	Build call for createTransfer
Transfer	createTransferReversal(String transferId, CreateReversalRequest createReversalRequest)	Refund or Reverse a Transfer Reverse a transfer with a `type` of **DEBIT**.
okhttp3.Call	createTransferReversalAsync(String transferId, CreateReversalRequest createReversalRequest, ApiCallback<Transfer> _callback)	Refund or Reverse a Transfer (asynchronously) Reverse a transfer with a `type` of **DEBIT**.
okhttp3.Call	createTransferReversalCall(String transferId, CreateReversalRequest createReversalRequest, ApiCallback _callback)	Build call for createTransferReversal
ApiResponse<Transfer>	createTransferReversalWithHttpInfo(String transferId, CreateReversalRequest createReversalRequest)	Refund or Reverse a Transfer Reverse a transfer with a `type` of **DEBIT**.
ApiResponse<Transfer>	createTransferWithHttpInfo(CreateTransferRequest createTransferRequest)	Create a Transfer Create a `Transfer`.
Transfer	get(String transferId)	Get a Transfer Retrieve a `transfer`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getTransferAsync(String transferId, ApiCallback<Transfer> _callback)	Get a Transfer (asynchronously) Retrieve a `transfer`.
okhttp3.Call	getTransferCall(String transferId, ApiCallback _callback)	Build call for getTransfer
ApiResponse<Transfer>	getTransferWithHttpInfo(String transferId)	Get a Transfer Retrieve a `transfer`.
TransfersList	list(ListTransfersQueryParams listTransfersQueryParams)	List Transfers Retrieve a list of `Transfers`.
TransfersList	listTransfersReversals(String transferId, ListTransferReversalsQueryParams listTransferReversalsQueryParams)	List Reversals on a Transfer Retrieve a list of reversals for a `Transfer`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
Transfer	update(String transferId, UpdateTransferRequest updateTransferRequest)	Update a Transfer Update a `Transfer`.
okhttp3.Call	updateTransferAsync(String transferId, UpdateTransferRequest updateTransferRequest, ApiCallback<Transfer> _callback)	Update a Transfer (asynchronously) Update a `Transfer`.
okhttp3.Call	updateTransferCall(String transferId, UpdateTransferRequest updateTransferRequest, ApiCallback _callback)	Build call for updateTransfer
ApiResponse<Transfer>	updateTransferWithHttpInfo(String transferId, UpdateTransferRequest updateTransferRequest)	Update a Transfer Update a `Transfer`.

Methods inherited from class java.lang.Object

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

Constructor Details

TransfersApi

public TransfersApi()

TransfersApi

public TransfersApi(FinixClient finixClient)

Method Details

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)

createTransferCall

public okhttp3.Call createTransferCall(CreateTransferRequest createTransferRequest,
 ApiCallback _callback)
                                throws ApiException

Build call for createTransfer

Parameters:

createTransferRequest - (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 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 -
402	402 - Payment required	* 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

create

public Transfer create(CreateTransferRequest createTransferRequest)
                throws ApiException

Create a Transfer Create a `Transfer`. > By default, Finix implements a 3 (business) day delay when debiting bank accounts (i.e. eChecks).

Parameters:

createTransferRequest - (optional)

Returns:

Transfer

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 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 -
402	402 - Payment required	* 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createTransferWithHttpInfo

public ApiResponse<Transfer> createTransferWithHttpInfo(CreateTransferRequest createTransferRequest)
                                                 throws ApiException

Create a Transfer Create a `Transfer`. > By default, Finix implements a 3 (business) day delay when debiting bank accounts (i.e. eChecks).

Parameters:

createTransferRequest - (optional)

Returns:

ApiResponse<Transfer>

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 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 -
402	402 - Payment required	* 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createTransferAsync

public okhttp3.Call createTransferAsync(CreateTransferRequest createTransferRequest,
 ApiCallback<Transfer> _callback)
                                 throws ApiException

Create a Transfer (asynchronously) Create a `Transfer`. > By default, Finix implements a 3 (business) day delay when debiting bank accounts (i.e. eChecks).

Parameters:

createTransferRequest - (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 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 -
402	402 - Payment required	* 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createTransferReversalCall

public okhttp3.Call createTransferReversalCall(String transferId,
 CreateReversalRequest createReversalRequest,
 ApiCallback _callback)
                                        throws ApiException

Build call for createTransferReversal

Parameters:

transferId - ID of `transfer` object (required)

createReversalRequest - (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 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 -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createTransferReversal

public Transfer createTransferReversal(String transferId,
 CreateReversalRequest createReversalRequest)
                                throws ApiException

Refund or Reverse a Transfer Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**. The refund can get delivered in most cases without the physical card. The card only needs to be swiped (to receive the refund) when: - The payment type is **DEBIT**, and the transaction is no longer in the batch. - The payment type is **CREDIT**, and the transaction is no longer in the batch and is older than 45 days.

Parameters:

transferId - ID of `transfer` object (required)

createReversalRequest - (optional)

Returns:

Transfer

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 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 -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createTransferReversalWithHttpInfo

public ApiResponse<Transfer> createTransferReversalWithHttpInfo(String transferId,
 CreateReversalRequest createReversalRequest)
                                                         throws ApiException

Refund or Reverse a Transfer Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**. The refund can get delivered in most cases without the physical card. The card only needs to be swiped (to receive the refund) when: - The payment type is **DEBIT**, and the transaction is no longer in the batch. - The payment type is **CREDIT**, and the transaction is no longer in the batch and is older than 45 days.

Parameters:

transferId - ID of `transfer` object (required)

createReversalRequest - (optional)

Returns:

ApiResponse<Transfer>

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 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 -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createTransferReversalAsync

public okhttp3.Call createTransferReversalAsync(String transferId,
 CreateReversalRequest createReversalRequest,
 ApiCallback<Transfer> _callback)
                                         throws ApiException

Refund or Reverse a Transfer (asynchronously) Reverse a transfer with a `type` of **DEBIT**. This reversal creates a new `Transfer` resource with a `type` of **REVERSAL**. The refund can get delivered in most cases without the physical card. The card only needs to be swiped (to receive the refund) when: - The payment type is **DEBIT**, and the transaction is no longer in the batch. - The payment type is **CREDIT**, and the transaction is no longer in the batch and is older than 45 days.

Parameters:

transferId - ID of `transfer` object (required)

createReversalRequest - (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 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 -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Error	* finix-apiuser-role - * date - * x-request-id -

getTransferCall

public okhttp3.Call getTransferCall(String transferId,
 ApiCallback _callback)
                             throws ApiException

Build call for getTransfer

Parameters:

transferId - ID of `transfer` object. (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 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 Transfer get(String transferId)
             throws ApiException

Get a Transfer Retrieve a `transfer`.

Parameters:

transferId - ID of `transfer` object. (required)

Returns:

Transfer

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

getTransferWithHttpInfo

public ApiResponse<Transfer> getTransferWithHttpInfo(String transferId)
                                              throws ApiException

Get a Transfer Retrieve a `transfer`.

Parameters:

transferId - ID of `transfer` object. (required)

Returns:

ApiResponse<Transfer>

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

getTransferAsync

public okhttp3.Call getTransferAsync(String transferId,
 ApiCallback<Transfer> _callback)
                              throws ApiException

Get a Transfer (asynchronously) Retrieve a `transfer`.

Parameters:

transferId - ID of `transfer` object. (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 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 -

listTransfersReversals

public TransfersList listTransfersReversals(String transferId,
 ListTransferReversalsQueryParams listTransferReversalsQueryParams)
                                     throws ApiException

List Reversals on a Transfer Retrieve a list of reversals for a `Transfer`.

Parameters:

transferId - ID of `transfer` object (required)

Returns:

APIlistTransferReversalsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Reversals	* 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 TransfersList list(ListTransfersQueryParams listTransfersQueryParams)
                   throws ApiException

List Transfers Retrieve a list of `Transfers`.

Returns:

APIlistTransfersRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Transfer objects	* 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 -

updateTransferCall

public okhttp3.Call updateTransferCall(String transferId,
 UpdateTransferRequest updateTransferRequest,
 ApiCallback _callback)
                                throws ApiException

Build call for updateTransfer

Parameters:

transferId - ID of `transfer` object. (required)

updateTransferRequest - (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
200	Single 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 -

update

public Transfer update(String transferId,
 UpdateTransferRequest updateTransferRequest)
                throws ApiException

Update a Transfer Update a `Transfer`.

Parameters:

transferId - ID of `transfer` object. (required)

updateTransferRequest - (optional)

Returns:

Transfer

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

updateTransferWithHttpInfo

public ApiResponse<Transfer> updateTransferWithHttpInfo(String transferId,
 UpdateTransferRequest updateTransferRequest)
                                                 throws ApiException

Update a Transfer Update a `Transfer`.

Parameters:

transferId - ID of `transfer` object. (required)

updateTransferRequest - (optional)

Returns:

ApiResponse<Transfer>

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

updateTransferAsync

public okhttp3.Call updateTransferAsync(String transferId,
 UpdateTransferRequest updateTransferRequest,
 ApiCallback<Transfer> _callback)
                                 throws ApiException

Update a Transfer (asynchronously) Update a `Transfer`.

Parameters:

transferId - ID of `transfer` object. (required)

updateTransferRequest - (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
200	Single 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 -