Class InvoicePayParams


public class InvoicePayParams extends ApiRequestParams
  • Method Details

    • builder

      public static InvoicePayParams.Builder builder()
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getForgive

      public Boolean getForgive()
      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.

    • getMandate

      public Object getMandate()
      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.
    • getOffSession

      public Boolean getOffSession()
      Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).
    • getPaidOutOfBand

      public Boolean getPaidOutOfBand()
      Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to false.
    • getPaymentMethod

      public String getPaymentMethod()
      A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
    • getSource

      public String getSource()
      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.