Package api

Class BalanceTransfersApi.APIlistBalanceTransfersRequest

java.lang.Object
api.BalanceTransfersApi.APIlistBalanceTransfersRequest
Enclosing class:
BalanceTransfersApi
public class BalanceTransfersApi.APIlistBalanceTransfersRequest extends Object

  • Method Details

    • limit

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

    • offset

      public BalanceTransfersApi.APIlistBalanceTransfersRequest offset(Long offset)
      Set offset
      Parameters:
      offset - The number of items to skip before starting to collect the result set (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • pageNumber

      public BalanceTransfersApi.APIlistBalanceTransfersRequest pageNumber(Long pageNumber)
      Set pageNumber
      Parameters:
      pageNumber - The page number to list (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • pageSize

      public BalanceTransfersApi.APIlistBalanceTransfersRequest pageSize(Long pageSize)
      Set pageSize
      Parameters:
      pageSize - The size of the page (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • createdAtGte

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

    • createdAtLte

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

    • updatedAtGte

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

    • updatedAtLte

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

    • idempotencyId

      public BalanceTransfersApi.APIlistBalanceTransfersRequest idempotencyId(String idempotencyId)
      Set idempotencyId
      Parameters:
      idempotencyId - Filter by idempotency_id (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • amount

      public BalanceTransfersApi.APIlistBalanceTransfersRequest amount(Long amount)
      Set amount
      Parameters:
      amount - Filter by an amount equal to the given value (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • description

      public BalanceTransfersApi.APIlistBalanceTransfersRequest description(String description)
      Set description
      Parameters:
      description - Filter by the `description` value (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • destination

      public BalanceTransfersApi.APIlistBalanceTransfersRequest destination(String destination)
      Set destination
      Parameters:
      destination - Filter by the `Payment Instrument` saved in `destination` (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • externalReferenceId

      public BalanceTransfersApi.APIlistBalanceTransfersRequest externalReferenceId(String externalReferenceId)
      Set externalReferenceId
      Parameters:
      externalReferenceId - Filter by the value saved in `external_reference_id` (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • referenceId

      public BalanceTransfersApi.APIlistBalanceTransfersRequest referenceId(String referenceId)
      Set referenceId
      Parameters:
      referenceId - Filter by the value saved in `reference_id` (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • source

      public BalanceTransfersApi.APIlistBalanceTransfersRequest source(String source)
      Set source
      Parameters:
      source - Filter by the `Payment Instrument` saved in `source` (optional)
      Returns:
      APIlistBalanceTransfersRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for listBalanceTransfers
      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 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 -

    • execute

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

    • executeWithHttpInfo

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

    • executeAsync

      public okhttp3.Call executeAsync(ApiCallback<BalanceTransferList> _callback) throws ApiException
      Execute listBalanceTransfers 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 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 -