Package api

Class SettlementsApi.APIlistSettlementsRequest

java.lang.Object
api.SettlementsApi.APIlistSettlementsRequest
Enclosing class:
SettlementsApi
public class SettlementsApi.APIlistSettlementsRequest extends Object

  • Method Details

    • amount

      public SettlementsApi.APIlistSettlementsRequest amount(Long amount)
      Set amount
      Parameters:
      amount - Filter by a total amount equal to the given value (optional)
      Returns:
      APIlistSettlementsRequest

    • amountLt

      public SettlementsApi.APIlistSettlementsRequest amountLt(Long amountLt)
      Set amountLt
      Parameters:
      amountLt - Filter by a total amount less than (optional)
      Returns:
      APIlistSettlementsRequest

    • amountGt

      public SettlementsApi.APIlistSettlementsRequest amountGt(Long amountGt)
      Set amountGt
      Parameters:
      amountGt - Filter by a total amount greater than (optional)
      Returns:
      APIlistSettlementsRequest

    • amountLte

      public SettlementsApi.APIlistSettlementsRequest amountLte(Long amountLte)
      Set amountLte
      Parameters:
      amountLte - Filter by a total amount less than or equal (optional)
      Returns:
      APIlistSettlementsRequest

    • amountGte

      public SettlementsApi.APIlistSettlementsRequest amountGte(Long amountGte)
      Set amountGte
      Parameters:
      amountGte - Filter by a total amount greater than or equal (optional)
      Returns:
      APIlistSettlementsRequest

    • createdAtGte

      public SettlementsApi.APIlistSettlementsRequest createdAtGte(String createdAtGte)
      Set createdAtGte
      Parameters:
      createdAtGte - Filter where created_at is after the given date. (optional)
      Returns:
      APIlistSettlementsRequest

    • createdAtLte

      public SettlementsApi.APIlistSettlementsRequest createdAtLte(String createdAtLte)
      Set createdAtLte
      Parameters:
      createdAtLte - Filter where created_at is before the given date. (optional)
      Returns:
      APIlistSettlementsRequest

    • updatedAtGte

      public SettlementsApi.APIlistSettlementsRequest updatedAtGte(String updatedAtGte)
      Set updatedAtGte
      Parameters:
      updatedAtGte - Filter where updated_at is after the given date (optional)
      Returns:
      APIlistSettlementsRequest

    • updatedAtLte

      public SettlementsApi.APIlistSettlementsRequest updatedAtLte(String updatedAtLte)
      Set updatedAtLte
      Parameters:
      updatedAtLte - Filter where updated_at is before the given date (optional)
      Returns:
      APIlistSettlementsRequest

    • id

      public SettlementsApi.APIlistSettlementsRequest id(String id)
      Set id
      Parameters:
      id - Filter by id (optional)
      Returns:
      APIlistSettlementsRequest

    • limit

      public SettlementsApi.APIlistSettlementsRequest limit(Long limit)
      Set limit
      Parameters:
      limit - The numbers of items to return (optional)
      Returns:
      APIlistSettlementsRequest

    • afterCursor

      public SettlementsApi.APIlistSettlementsRequest afterCursor(String afterCursor)
      Set afterCursor
      Parameters:
      afterCursor - Return every resource created after the cursor value. (optional)
      Returns:
      APIlistSettlementsRequest

    • beforeCursor

      public SettlementsApi.APIlistSettlementsRequest beforeCursor(String beforeCursor)
      Set beforeCursor
      Parameters:
      beforeCursor - Return every resource created before the cursor value. (optional)
      Returns:
      APIlistSettlementsRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for listSettlements
      Parameters:
      _callback - ApiCallback API callback
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      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 -

    • execute

      public SettlementsList execute() throws ApiException
      Execute listSettlements request
      Returns:
      SettlementsList
      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 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 -

    • executeWithHttpInfo

      public ApiResponse<SettlementsList> executeWithHttpInfo() throws ApiException
      Execute listSettlements request with HTTP info returned
      Returns:
      ApiResponse<SettlementsList>
      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 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 -

    • executeAsync

      public okhttp3.Call executeAsync(ApiCallback<SettlementsList> _callback) throws ApiException
      Execute listSettlements request (asynchronously)
      Parameters:
      _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 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 -