Package com.stripe.param

Class InvoicePayParams

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static InvoicePayParams.Builder builder()  
      java.util.List<java.lang.String> getExpand()
      Specifies which fields in the response should be expanded.
      java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library.
      java.lang.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.
      java.lang.Boolean getOffSession()
      Indicates if a customer is on or off-session while an invoice payment is attempted.
      java.lang.Boolean getPaidOutOfBand()
      Boolean representing whether an invoice is paid outside of Stripe.
      java.lang.String getPaymentMethod()
      A PaymentMethod to be charged.
      java.lang.String getSource()
      A payment source to be charged.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getExpand

        public java.util.List<java.lang.String> getExpand()
        Specifies which fields in the response should be expanded.

      • getExtraParams

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.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.

      • getOffSession

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

      • getPaidOutOfBand

        public java.lang.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 java.lang.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 java.lang.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.