Package com.stripe.param

Class MandateListParams.Builder

java.lang.Object
com.stripe.param.MandateListParams.Builder
Enclosing class:
MandateListParams
public static class MandateListParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public MandateListParams build()
      Finalize and obtain parameter instance from this builder.

    • setEndingBefore

      public MandateListParams.Builder setEndingBefore(String endingBefore)
      A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    • addExpand

      public MandateListParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MandateListParams.expand for the field documentation.

    • addAllExpand

      public MandateListParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MandateListParams.expand for the field documentation.

    • putExtraParam

      public MandateListParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MandateListParams.extraParams for the field documentation.

    • putAllExtraParam

      public MandateListParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MandateListParams.extraParams for the field documentation.

    • setLimit

      public MandateListParams.Builder setLimit(Long limit)
      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • setOnBehalfOf

      public MandateListParams.Builder setOnBehalfOf(String onBehalfOf)
      The Stripe account ID that the mandates are intended for. Learn more about the use case for connected accounts payments.

    • setPaymentMethod

      public MandateListParams.Builder setPaymentMethod(String paymentMethod)
      Required.

    • setStartingAfter

      public MandateListParams.Builder setStartingAfter(String startingAfter)
      A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    • setStatus

      public MandateListParams.Builder setStatus(MandateListParams.Status status)
      Required. The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of active, pending, or inactive.