Package api

Class PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest

java.lang.Object
api.PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest
Enclosing class:
PaymentInstrumentsApi
public class PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest extends Object

  • Method Details

    • limit

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

    • afterCursor

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

    • accountLast4

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest accountLast4(String accountLast4)
      Set accountLast4
      Parameters:
      accountLast4 - Filter by the last 4 digits of the account if available. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • accountRoutingNumber

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest accountRoutingNumber(String accountRoutingNumber)
      Set accountRoutingNumber
      Parameters:
      accountRoutingNumber - Filter by the account routing number if available. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • application

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest application(String application)
      Set application
      Parameters:
      application - Filter by application id (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • bin

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest bin(String bin)
      Set bin
      Parameters:
      bin - Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • createdAtGte

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

    • createdAtLte

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

    • expirationMonth

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest expirationMonth(String expirationMonth)
      Set expirationMonth
      Parameters:
      expirationMonth - Filter by the expiration month associated with the `Payment Instrument` if applicable. This filter only applies to payment cards. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • expirationYear

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest expirationYear(String expirationYear)
      Set expirationYear
      Parameters:
      expirationYear - Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • lastFour

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest lastFour(String lastFour)
      Set lastFour
      Parameters:
      lastFour - Filter by the last 4 digits of the Payment Instrument card. This filter only applies to payment cards. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • name

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest name(String name)
      Set name
      Parameters:
      name - Filter by the name. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • ownerIdentityId

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest ownerIdentityId(String ownerIdentityId)
      Set ownerIdentityId
      Parameters:
      ownerIdentityId - Filter by the owner id of the associated identity. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • type

      public PaymentInstrumentsApi.APIlistPaymentInstrumentsRequest type(String type)
      Set type
      Parameters:
      type - Filter by the payment instrument type. (optional)
      Returns:
      APIlistPaymentInstrumentsRequest

    • beforeCursor

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

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for listPaymentInstruments
      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 Payment Instrument 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 PaymentInstrumentsList execute() throws ApiException
      Execute listPaymentInstruments request
      Returns:
      PaymentInstrumentsList
      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 Payment Instrument 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<PaymentInstrumentsList> executeWithHttpInfo() throws ApiException
      Execute listPaymentInstruments request with HTTP info returned
      Returns:
      ApiResponse<PaymentInstrumentsList>
      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 Payment Instrument 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<PaymentInstrumentsList> _callback) throws ApiException
      Execute listPaymentInstruments 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 Payment Instrument 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 -