Package com.stripe.param.checkout

Class SessionCreateParams.PaymentMethodOptions.Paypal

java.lang.Object
com.stripe.param.checkout.SessionCreateParams.PaymentMethodOptions.Paypal
Enclosing class:
SessionCreateParams.PaymentMethodOptions
public static class SessionCreateParams.PaymentMethodOptions.Paypal extends Object

  • Method Details

    • builder

      public static SessionCreateParams.PaymentMethodOptions.Paypal.Builder builder()

    • getCaptureMethod

      public ApiRequestParams.EnumParam getCaptureMethod()
      Controls when the funds will be captured from the customer's account.

    • getExtraParams

      public Map<String,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.

    • getPreferredLocale

      public SessionCreateParams.PaymentMethodOptions.Paypal.PreferredLocale getPreferredLocale()
      Preferred locale of the PayPal checkout page that the customer is redirected to.

    • getReference

      public String getReference()
      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.

    • getRiskCorrelationId

      public String getRiskCorrelationId()
      The risk correlation ID for an on-session payment using a saved PayPal payment method.

    • getSetupFutureUsage

      public ApiRequestParams.EnumParam getSetupFutureUsage()
      Indicates that you intend to make future payments with this PaymentIntent's payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session.