Class PaymentIntentCreateParams.Shipping

java.lang.Object
com.stripe.param.PaymentIntentCreateParams.Shipping
Enclosing class:
PaymentIntentCreateParams

public static class PaymentIntentCreateParams.Shipping extends Object
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.

  • Method Details

    • builder

    • getAddress

      Shipping address.
    • getCarrier

      public String getCarrier()
      The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    • 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.
    • getName

      public String getName()
      Recipient name.
    • getPhone

      public String getPhone()
      Recipient phone (including extension).
    • getTrackingNumber

      public String getTrackingNumber()
      The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.