com.stripe.param

Class PaymentIntentConfirmParams.Builder

java.lang.Object

com.stripe.param.PaymentIntentConfirmParams.Builder

Enclosing class:

PaymentIntentConfirmParams

public static class PaymentIntentConfirmParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PaymentIntentConfirmParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
PaymentIntentConfirmParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
PaymentIntentConfirmParams	build() Finalize and obtain parameter instance from this builder.
PaymentIntentConfirmParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
PaymentIntentConfirmParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
PaymentIntentConfirmParams.Builder	setOffSession(PaymentIntentConfirmParams.OffSession offSession) Used in payment flows that collect payment details and charge later, when the customer is not available to complete additional required steps for the payment.
PaymentIntentConfirmParams.Builder	setPaymentMethod(java.lang.String paymentMethod) ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.
PaymentIntentConfirmParams.Builder	setReceiptEmail(java.lang.String receiptEmail) Email address that the receipt for the resulting payment will be sent to.
PaymentIntentConfirmParams.Builder	setReturnUrl(java.lang.String returnUrl) The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
PaymentIntentConfirmParams.Builder	setSavePaymentMethod(java.lang.Boolean savePaymentMethod) If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save the payment method to the customer.
PaymentIntentConfirmParams.Builder	setShipping(EmptyParam shipping) Shipping information for this PaymentIntent.
PaymentIntentConfirmParams.Builder	setShipping(PaymentIntentConfirmParams.Shipping shipping) Shipping information for this PaymentIntent.
PaymentIntentConfirmParams.Builder	setSource(java.lang.String source) This is a legacy field that will be removed in the future.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public PaymentIntentConfirmParams build()

Finalize and obtain parameter instance from this builder.

addExpand

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

addAllExpand

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

putExtraParam

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

putAllExtraParam

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

setOffSession

public PaymentIntentConfirmParams.Builder setOffSession(PaymentIntentConfirmParams.OffSession offSession)

Used in payment flows that collect payment details and charge later, when the customer is not available to complete additional required steps for the payment. Setting this parameter indicates that this payment attempt is happening while the customer is not in your checkout flow. Use `recurring` for payments made on a recurring basis (for example, subscriptions) and `one_off` for all other off-session payments.

setPaymentMethod

public PaymentIntentConfirmParams.Builder setPaymentMethod(java.lang.String paymentMethod)

ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.

setReceiptEmail

public PaymentIntentConfirmParams.Builder setReceiptEmail(java.lang.String receiptEmail)

Email address that the receipt for the resulting payment will be sent to.

setReturnUrl

public PaymentIntentConfirmParams.Builder setReturnUrl(java.lang.String returnUrl)

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

setSavePaymentMethod

public PaymentIntentConfirmParams.Builder setSavePaymentMethod(java.lang.Boolean savePaymentMethod)

If the PaymentIntent has a `payment_method` and a `customer` or if you're attaching a payment method to the PaymentIntent in this request, you can pass `save_payment_method=true` to save the payment method to the customer. Defaults to `false`.

If the payment method is already saved to a customer, this does nothing. If this type of payment method cannot be saved to a customer, the request will error.

setShipping

public PaymentIntentConfirmParams.Builder setShipping(PaymentIntentConfirmParams.Shipping shipping)

Shipping information for this PaymentIntent.

setShipping

public PaymentIntentConfirmParams.Builder setShipping(EmptyParam shipping)

Shipping information for this PaymentIntent.

setSource

public PaymentIntentConfirmParams.Builder setSource(java.lang.String source)

This is a legacy field that will be removed in the future. It is the ID of the Source object to attach to this PaymentIntent. Please use the `payment_method` field instead, which also supports Source, Card, and BankAccount objects.