Package com.stripe.param

Class InvoicePayParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • addExpand

      public InvoicePayParams.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 InvoicePayParams.expand for the field documentation.

    • addAllExpand

      public InvoicePayParams.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 InvoicePayParams.expand for the field documentation.

    • putExtraParam

      public InvoicePayParams.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 InvoicePayParams.extraParams for the field documentation.

    • putAllExtraParam

      public InvoicePayParams.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 InvoicePayParams.extraParams for the field documentation.

    • setForgive

      public InvoicePayParams.Builder setForgive(Boolean forgive)
      In cases where the source used to pay the invoice has insufficient funds, passing forgive=true controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.

      Passing forgive=false will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to false.

    • setMandate

      public InvoicePayParams.Builder setMandate(String mandate)
      ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.

    • setMandate

      public InvoicePayParams.Builder setMandate(EmptyParam mandate)
      ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.

    • setOffSession

      public InvoicePayParams.Builder setOffSession(Boolean offSession)
      Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).

    • setPaidOutOfBand

      public InvoicePayParams.Builder setPaidOutOfBand(Boolean paidOutOfBand)
      Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to false.

    • setPaymentMethod

      public InvoicePayParams.Builder setPaymentMethod(String paymentMethod)
      A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.

    • setSource

      public InvoicePayParams.Builder setSource(String source)
      A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.