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