Package com.stripe.param.checkout

Class SessionCreateParams.PaymentMethodOptions.Paypal.Builder

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.PaymentMethodOptions.Paypal.Builder

Enclosing class:

SessionCreateParams.PaymentMethodOptions.Paypal

public static class SessionCreateParams.PaymentMethodOptions.Paypal.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SessionCreateParams.PaymentMethodOptions.Paypal	build()	Finalize and obtain parameter instance from this builder.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setCaptureMethod(SessionCreateParams.PaymentMethodOptions.Paypal.CaptureMethod captureMethod)	Controls when the funds will be captured from the customer's account.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setCaptureMethod(EmptyParam captureMethod)	Controls when the funds will be captured from the customer's account.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setPreferredLocale(SessionCreateParams.PaymentMethodOptions.Paypal.PreferredLocale preferredLocale)	Preferred locale of the PayPal checkout page that the customer is redirected to.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setReference(String reference)	A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setRiskCorrelationId(String riskCorrelationId)	The risk correlation ID for an on-session payment using a saved PayPal payment method.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setSetupFutureUsage(SessionCreateParams.PaymentMethodOptions.Paypal.SetupFutureUsage setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
SessionCreateParams.PaymentMethodOptions.Paypal.Builder	setSetupFutureUsage(EmptyParam setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public SessionCreateParams.PaymentMethodOptions.Paypal build()

Finalize and obtain parameter instance from this builder.

setCaptureMethod

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setCaptureMethod(SessionCreateParams.PaymentMethodOptions.Paypal.CaptureMethod captureMethod)

Controls when the funds will be captured from the customer's account.

setCaptureMethod

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setCaptureMethod(EmptyParam captureMethod)

Controls when the funds will be captured from the customer's account.

putExtraParam

public SessionCreateParams.PaymentMethodOptions.Paypal.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 SessionCreateParams.PaymentMethodOptions.Paypal.extraParams for the field documentation.

putAllExtraParam

public SessionCreateParams.PaymentMethodOptions.Paypal.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 SessionCreateParams.PaymentMethodOptions.Paypal.extraParams for the field documentation.

setPreferredLocale

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setPreferredLocale(SessionCreateParams.PaymentMethodOptions.Paypal.PreferredLocale preferredLocale)

Preferred locale of the PayPal checkout page that the customer is redirected to.

setReference

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setReference(String reference)

A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.

setRiskCorrelationId

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setRiskCorrelationId(String riskCorrelationId)

The risk correlation ID for an on-session payment using a saved PayPal payment method.

setSetupFutureUsage

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setSetupFutureUsage(SessionCreateParams.PaymentMethodOptions.Paypal.SetupFutureUsage setupFutureUsage)

Indicates that you intend to make future payments with this PaymentIntent's payment method.

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

setSetupFutureUsage

public SessionCreateParams.PaymentMethodOptions.Paypal.Builder setSetupFutureUsage(EmptyParam setupFutureUsage)

Indicates that you intend to make future payments with this PaymentIntent's payment method.

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.