Package com.stripe.param
Class InvoicePayParams.Builder
- java.lang.Object
-
- com.stripe.param.InvoicePayParams.Builder
-
- Enclosing class:
- InvoicePayParams
public static class InvoicePayParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InvoicePayParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.InvoicePayParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.InvoicePayParams
build()
Finalize and obtain parameter instance from this builder.InvoicePayParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.InvoicePayParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.InvoicePayParams.Builder
setForgive(java.lang.Boolean forgive)
In cases where the source used to pay the invoice has insufficient funds, passingforgive=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.InvoicePayParams.Builder
setOffSession(java.lang.Boolean offSession)
Indicates if a customer is on or off-session while an invoice payment is attempted.InvoicePayParams.Builder
setPaidOutOfBand(java.lang.Boolean paidOutOfBand)
Boolean representing whether an invoice is paid outside of Stripe.InvoicePayParams.Builder
setPaymentMethod(java.lang.String paymentMethod)
A PaymentMethod to be charged.InvoicePayParams.Builder
setSource(java.lang.String source)
A payment source to be charged.
-
-
-
Method Detail
-
build
public InvoicePayParams build()
Finalize and obtain parameter instance from this builder.
-
addExpand
public InvoicePayParams.Builder addExpand(java.lang.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. SeeInvoicePayParams.expand
for the field documentation.
-
addAllExpand
public InvoicePayParams.Builder addAllExpand(java.util.List<java.lang.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. SeeInvoicePayParams.expand
for the field documentation.
-
putExtraParam
public InvoicePayParams.Builder putExtraParam(java.lang.String key, java.lang.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. SeeInvoicePayParams.extraParams
for the field documentation.
-
putAllExtraParam
public InvoicePayParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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. SeeInvoicePayParams.extraParams
for the field documentation.
-
setForgive
public InvoicePayParams.Builder setForgive(java.lang.Boolean forgive)
In cases where the source used to pay the invoice has insufficient funds, passingforgive=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 tofalse
.
-
setOffSession
public InvoicePayParams.Builder setOffSession(java.lang.Boolean offSession)
Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults totrue
(off-session).
-
setPaidOutOfBand
public InvoicePayParams.Builder setPaidOutOfBand(java.lang.Boolean paidOutOfBand)
Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults tofalse
.
-
setPaymentMethod
public InvoicePayParams.Builder setPaymentMethod(java.lang.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(java.lang.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.
-
-