Package api

Class SettlementsApi

java.lang.Object

api.SettlementsApi

public class SettlementsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SettlementsApi.APIlistSettlementFundingTransfersRequest
class	SettlementsApi.APIlistSettlementsRequest
class	SettlementsApi.APIlistSettlementTransfersRequest

Constructor Summary

Constructors

Constructor	Description
SettlementsApi()
SettlementsApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
Settlement	create(CreateSettlementRequest createSettlementRequest)	Create a Batch Settlement Create a batch `Settlement`.
okhttp3.Call	createSettlementAsync(CreateSettlementRequest createSettlementRequest, ApiCallback<Settlement> _callback)	Create a Batch Settlement (asynchronously) Create a batch `Settlement`.
okhttp3.Call	createSettlementCall(CreateSettlementRequest createSettlementRequest, ApiCallback _callback)	Build call for createSettlement
ApiResponse<Settlement>	createSettlementWithHttpInfo(CreateSettlementRequest createSettlementRequest)	Create a Batch Settlement Create a batch `Settlement`.
Settlement	get(String settlementId)	Get a Settlement Retreive the details of a `Settlement`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getSettlementAsync(String settlementId, ApiCallback<Settlement> _callback)	Get a Settlement (asynchronously) Retreive the details of a `Settlement`.
okhttp3.Call	getSettlementCall(String settlementId, ApiCallback _callback)	Build call for getSettlement
ApiResponse<Settlement>	getSettlementWithHttpInfo(String settlementId)	Get a Settlement Retreive the details of a `Settlement`.
SettlementsList	list(ListSettlementsQueryParams listSettlementsQueryParams)	List Settlements Retrieve a list of `Settlements`.
TransfersList	listBySettlementId(String settlementId, ListSettlementTransfersQueryParams listSettlementTransfersQueryParams)	List Settlement Transfers Retrieve the `Transfers` in a `Settlement` that have `type` **DEBIT** or **REFUND**.
TransfersList	listFundingTransfers(String settlementId, ListSettlementFundingTransfersQueryParams listSettlementFundingTransfersQueryParams)	List Settlement Funding Transfers Retrieve the `Transfers` in a `Settlement` that have `type` **CREDIT**.
okhttp3.Call	putSettlementAsync(String settlementId, UpdateSettlementRequest updateSettlementRequest, ApiCallback<Settlement> _callback)	Update a Settlement (asynchronously) Update a `Settlement`.
okhttp3.Call	putSettlementCall(String settlementId, UpdateSettlementRequest updateSettlementRequest, ApiCallback _callback)	Build call for putSettlement
ApiResponse<Settlement>	putSettlementWithHttpInfo(String settlementId, UpdateSettlementRequest updateSettlementRequest)	Update a Settlement Update a `Settlement`.
okhttp3.Call	removeSettlementTransfersAsync(String settlementId, RemoveSettlementTransfer removeSettlementTransfer, ApiCallback<Void> _callback)	Delete Settlement Transfers (asynchronously) Remove a `Transfer` from a `Settlement`.
okhttp3.Call	removeSettlementTransfersCall(String settlementId, RemoveSettlementTransfer removeSettlementTransfer, ApiCallback _callback)	Build call for removeSettlementTransfers
ApiResponse<Void>	removeSettlementTransfersWithHttpInfo(String settlementId, RemoveSettlementTransfer removeSettlementTransfer)	Delete Settlement Transfers Remove a `Transfer` from a `Settlement`.
void	removeTransfersFromSettlement(String settlementId, RemoveSettlementTransfer removeSettlementTransfer)	Delete Settlement Transfers Remove a `Transfer` from a `Settlement`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
Settlement	update(String settlementId, UpdateSettlementRequest updateSettlementRequest)	Update a Settlement Update a `Settlement`.

Methods inherited from class java.lang.Object

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

Constructor Details

SettlementsApi

public SettlementsApi()

SettlementsApi

public SettlementsApi(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)

createSettlementCall

public okhttp3.Call createSettlementCall(CreateSettlementRequest createSettlementRequest,
 ApiCallback _callback)
                                  throws ApiException

Build call for createSettlement

Parameters:

createSettlementRequest - (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	`Settlement` 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 Settlement create(CreateSettlementRequest createSettlementRequest)
                  throws ApiException

Create a Batch Settlement Create a batch `Settlement`. A `Settlement` is a collection of **SUCCEEDED** `Transfers` that are ready to get paid out to a `Merchant`.

Parameters:

createSettlementRequest - (optional)

Returns:

Settlement

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

createSettlementWithHttpInfo

public ApiResponse<Settlement> createSettlementWithHttpInfo(CreateSettlementRequest createSettlementRequest)
                                                     throws ApiException

Create a Batch Settlement Create a batch `Settlement`. A `Settlement` is a collection of **SUCCEEDED** `Transfers` that are ready to get paid out to a `Merchant`.

Parameters:

createSettlementRequest - (optional)

Returns:

ApiResponse<Settlement>

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

createSettlementAsync

public okhttp3.Call createSettlementAsync(CreateSettlementRequest createSettlementRequest,
 ApiCallback<Settlement> _callback)
                                   throws ApiException

Create a Batch Settlement (asynchronously) Create a batch `Settlement`. A `Settlement` is a collection of **SUCCEEDED** `Transfers` that are ready to get paid out to a `Merchant`.

Parameters:

createSettlementRequest - (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	`Settlement` 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 -

getSettlementCall

public okhttp3.Call getSettlementCall(String settlementId,
 ApiCallback _callback)
                               throws ApiException

Build call for getSettlement

Parameters:

settlementId - ID of `Settlement` 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	`Settlement` 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 Settlement get(String settlementId)
               throws ApiException

Get a Settlement Retreive the details of a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

Returns:

Settlement

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

getSettlementWithHttpInfo

public ApiResponse<Settlement> getSettlementWithHttpInfo(String settlementId)
                                                  throws ApiException

Get a Settlement Retreive the details of a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

Returns:

ApiResponse<Settlement>

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

getSettlementAsync

public okhttp3.Call getSettlementAsync(String settlementId,
 ApiCallback<Settlement> _callback)
                                throws ApiException

Get a Settlement (asynchronously) Retreive the details of a `Settlement`.

Parameters:

settlementId - ID of `Settlement` 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	`Settlement` 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 -

listFundingTransfers

public TransfersList listFundingTransfers(String settlementId,
 ListSettlementFundingTransfersQueryParams listSettlementFundingTransfersQueryParams)
                                   throws ApiException

List Settlement Funding Transfers Retrieve the `Transfers` in a `Settlement` that have `type` **CREDIT**.

Parameters:

settlementId - ID of `Settlement` object. (required)

Returns:

APIlistSettlementFundingTransfersRequest

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 -

listBySettlementId

public TransfersList listBySettlementId(String settlementId,
 ListSettlementTransfersQueryParams listSettlementTransfersQueryParams)
                                 throws ApiException

List Settlement Transfers Retrieve the `Transfers` in a `Settlement` that have `type` **DEBIT** or **REFUND**.

Parameters:

settlementId - ID of `Settlement` object. (required)

Returns:

APIlistSettlementTransfersRequest

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 -

list

public SettlementsList list(ListSettlementsQueryParams listSettlementsQueryParams)
                     throws ApiException

List Settlements Retrieve a list of `Settlements`.

Returns:

APIlistSettlementsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of `Settlement` 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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putSettlementCall

public okhttp3.Call putSettlementCall(String settlementId,
 UpdateSettlementRequest updateSettlementRequest,
 ApiCallback _callback)
                               throws ApiException

Build call for putSettlement

Parameters:

settlementId - ID of `Settlement` object. (required)

updateSettlementRequest - (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	`Settlement` 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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

update

public Settlement update(String settlementId,
 UpdateSettlementRequest updateSettlementRequest)
                  throws ApiException

Update a Settlement Update a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

updateSettlementRequest - (optional)

Returns:

Settlement

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	`Settlement` 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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putSettlementWithHttpInfo

public ApiResponse<Settlement> putSettlementWithHttpInfo(String settlementId,
 UpdateSettlementRequest updateSettlementRequest)
                                                  throws ApiException

Update a Settlement Update a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

updateSettlementRequest - (optional)

Returns:

ApiResponse<Settlement>

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	`Settlement` 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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putSettlementAsync

public okhttp3.Call putSettlementAsync(String settlementId,
 UpdateSettlementRequest updateSettlementRequest,
 ApiCallback<Settlement> _callback)
                                throws ApiException

Update a Settlement (asynchronously) Update a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

updateSettlementRequest - (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	`Settlement` 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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

removeSettlementTransfersCall

public okhttp3.Call removeSettlementTransfersCall(String settlementId,
 RemoveSettlementTransfer removeSettlementTransfer,
 ApiCallback _callback)
                                           throws ApiException

Build call for removeSettlementTransfers

Parameters:

settlementId - ID of `Settlement` object. (required)

removeSettlementTransfer - (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
204	No content	* 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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

removeTransfersFromSettlement

public void removeTransfersFromSettlement(String settlementId,
 RemoveSettlementTransfer removeSettlementTransfer)
                                   throws ApiException

Delete Settlement Transfers Remove a `Transfer` from a `Settlement`. As long as the `Settlement` hasn't been funded, you can remove the `Transfer` or an array of `Transfers`, along with its corresponding `fee` from a batch `Settlement`. > Per the JSON API for deleting a resource, our API doesn't have a response body when removing a `Transfer` from a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

removeSettlementTransfer - (optional)

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
204	No content	* 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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

removeSettlementTransfersWithHttpInfo

public ApiResponse<Void> removeSettlementTransfersWithHttpInfo(String settlementId,
 RemoveSettlementTransfer removeSettlementTransfer)
                                                        throws ApiException

Delete Settlement Transfers Remove a `Transfer` from a `Settlement`. As long as the `Settlement` hasn't been funded, you can remove the `Transfer` or an array of `Transfers`, along with its corresponding `fee` from a batch `Settlement`. > Per the JSON API for deleting a resource, our API doesn't have a response body when removing a `Transfer` from a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

removeSettlementTransfer - (optional)

Returns:

ApiResponse<Void>

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
204	No content	* 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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

removeSettlementTransfersAsync

public okhttp3.Call removeSettlementTransfersAsync(String settlementId,
 RemoveSettlementTransfer removeSettlementTransfer,
 ApiCallback<Void> _callback)
                                            throws ApiException

Delete Settlement Transfers (asynchronously) Remove a `Transfer` from a `Settlement`. As long as the `Settlement` hasn't been funded, you can remove the `Transfer` or an array of `Transfers`, along with its corresponding `fee` from a batch `Settlement`. > Per the JSON API for deleting a resource, our API doesn't have a response body when removing a `Transfer` from a `Settlement`.

Parameters:

settlementId - ID of `Settlement` object. (required)

removeSettlementTransfer - (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
204	No content	* 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	Invalid field	* finix-apiuser-role - * date - * x-request-id -