Class SetupIntentCreateParams


public class SetupIntentCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static SetupIntentCreateParams.Builder builder()
    • getAttachToSelf

      public Boolean getAttachToSelf()
      If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

      It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

    • getAutomaticPaymentMethods

      public SetupIntentCreateParams.AutomaticPaymentMethods getAutomaticPaymentMethods()
      When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
    • getConfirm

      public Boolean getConfirm()
      Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    • getConfirmationToken

      public String getConfirmationToken()
      ID of the ConfirmationToken used to confirm this SetupIntent.

      If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    • getCustomer

      public String getCustomer()
      ID of the Customer this SetupIntent belongs to, if one exists.

      If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • 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.
    • getFlowDirections

      public List<SetupIntentCreateParams.FlowDirection> getFlowDirections()
      Indicates the directions of money movement for which this payment method is intended to be used.

      Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

    • getMandateData

      public Object getMandateData()
      This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getOnBehalfOf

      public String getOnBehalfOf()
      The Stripe account ID created for this SetupIntent.
    • getPaymentMethod

      public String getPaymentMethod()
      ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
    • getPaymentMethodConfiguration

      public String getPaymentMethodConfiguration()
      The ID of the payment method configuration to use with this SetupIntent.
    • getPaymentMethodData

      public SetupIntentCreateParams.PaymentMethodData getPaymentMethodData()
      When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    • getPaymentMethodOptions

      public SetupIntentCreateParams.PaymentMethodOptions getPaymentMethodOptions()
      Payment method-specific configuration for this SetupIntent.
    • getPaymentMethodTypes

      public List<String> getPaymentMethodTypes()
      The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"].
    • getReturnUrl

      public String getReturnUrl()
      The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    • getSingleUse

      public SetupIntentCreateParams.SingleUse getSingleUse()
      If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.
    • getUsage

      public SetupIntentCreateParams.Usage getUsage()
      Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to off_session.
    • getUseStripeSdk

      public Boolean getUseStripeSdk()
      Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.