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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Settlement`	`create(String identityId, CreateSettlementRequest createSettlementRequest)`	Close Current Active Settlement Close the currently accruing `settlement`.
`okhttp3.Call`	`createIdentitySettlementAsync(String identityId, CreateSettlementRequest createSettlementRequest, ApiCallback<Settlement> _callback)`	Close Current Active Settlement (asynchronously) Close the currently accruing `settlement`.
`okhttp3.Call`	`createIdentitySettlementCall(String identityId, CreateSettlementRequest createSettlementRequest, ApiCallback _callback)`	Build call for createIdentitySettlement
`ApiResponse<Settlement>`	`createIdentitySettlementWithHttpInfo(String identityId, CreateSettlementRequest createSettlementRequest)`	Close Current Active Settlement Close the currently accruing `settlement`.
`Settlement`	`get(String settlementId)`	Fetch a Settlement Retreive the details of a `Settlement`.
`String`	`getCustomBaseUrl()`
`FinixClient`	`getFinixClient()`
`int`	`getHostIndex()`
`okhttp3.Call`	`getSettlementAsync(String settlementId, ApiCallback<Settlement> _callback)`	Fetch 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)`	Fetch a Settlement Retreive the details of a `Settlement`.
`FinixList`	`list(ListSettlementsQueryParams listSettlementsQueryParams)`	List All Settlements Retrieve a list of `Settlements`.
`FinixList`	`listFundingTransfers(String settlementId, ListSettlementFundingTransfersQueryParams listSettlementFundingTransfersQueryParams)`	List Settlement Funding Transfers List the funding `Transfers` that were created when a `Settlement` was approved that have `type` CREDIT or DEBIT.
`FinixList`	`listTransfersBySettlementId(String settlementId, ListSettlementTransfersQueryParams listSettlementTransfersQueryParams)`	List Settlement Transfers Retrieve a list of every `Transfer` in a `Settlement` that has `type` DEBIT or REFUND.
`okhttp3.Call`	`removeSettlementTransfersAsync(String settlementId, RemoveSettlementTransfer removeSettlementTransfer, ApiCallback<Void> _callback)`	Delete Settlement Transfers (asynchronously) Remove a `Transfer` that makes up 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` that makes up a `Settlement`.
`void`	`removeTransfersFromSettlement(String settlementId, RemoveSettlementTransfer removeSettlementTransfer)`	Delete Settlement Transfers Remove a `Transfer` that makes up a `Settlement`.
`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

SettlementsApi
```
public SettlementsApi()
```

SettlementsApi

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

createIdentitySettlementCall

public okhttp3.Call createIdentitySettlementCall(String identityId,
                                                 CreateSettlementRequest createSettlementRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createIdentitySettlement

Parameters:

identityId - ID of the `Identity` for the merchant you want to settle. (required)

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

create

public Settlement create(String identityId,
                         CreateSettlementRequest createSettlementRequest)
                  throws ApiException

Close Current Active Settlement Close the currently accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the merchant's bank account. Related Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement)

Parameters:

identityId - ID of the `Identity` for the merchant you want to settle. (required)

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

createIdentitySettlementWithHttpInfo

public ApiResponse<Settlement> createIdentitySettlementWithHttpInfo(String identityId,
                                                                    CreateSettlementRequest createSettlementRequest)
                                                             throws ApiException

Close Current Active Settlement Close the currently accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the merchant's bank account. Related Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement)

Parameters:

identityId - ID of the `Identity` for the merchant you want to settle. (required)

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

createIdentitySettlementAsync

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

Close Current Active Settlement (asynchronously) Close the currently accruing `settlement`. Finix, by default, creates accruing `settlements` then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement. The closed `Settlement` will not accrue any further transactions and gets immediately submitted for approval. - Any refunded `Transfers` get included in `Settlements` as a deduction. - **PENDING** `Transfers` don't get included in `Settlements`. - The `total_amount` minus the `total_fee` equals the `net_amount`. The `net_amount` is the amount in cents that gets deposited into the merchant's bank account. Related Guides: [Accruing Settlements](/guides/payouts/~accruing-settlements/#closing-an-accruing-settlement)

Parameters:

identityId - ID of the `Identity` for the merchant you want to settle. (required)

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

Fetch 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

Fetch 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

Fetch 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 FinixList listFundingTransfers(String settlementId,
                                      ListSettlementFundingTransfersQueryParams listSettlementFundingTransfersQueryParams)
                               throws ApiException

List Settlement Funding Transfers List the funding `Transfers` that were created when a `Settlement` was approved that have `type` **CREDIT** or **DEBIT**.

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 -

listTransfersBySettlementId

public FinixList listTransfersBySettlementId(String settlementId,
                                             ListSettlementTransfersQueryParams listSettlementTransfersQueryParams)
                                      throws ApiException

List Settlement Transfers Retrieve a list of every `Transfer` in a `Settlement` that has `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 FinixList list(ListSettlementsQueryParams listSettlementsQueryParams)
               throws ApiException

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

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` that makes up 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 the encompassing `Settlement`. - Funding `transfers` can't be deleted. > 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` that makes up 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 the encompassing `Settlement`. - Funding `transfers` can't be deleted. > 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` that makes up 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 the encompassing `Settlement`. - Funding `transfers` can't be deleted. > 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 -

Class SettlementsApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SettlementsApi

SettlementsApi

Method Detail

getFinixClient

setFinixClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

createIdentitySettlementCall

create

createIdentitySettlementWithHttpInfo

createIdentitySettlementAsync

getSettlementCall

get

getSettlementWithHttpInfo

getSettlementAsync

listFundingTransfers

listTransfersBySettlementId

list

removeSettlementTransfersCall

removeTransfersFromSettlement

removeSettlementTransfersWithHttpInfo

removeSettlementTransfersAsync