Search documentation of stripe_elixir

# StripeElixir.Params.SetupIntentCreateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for setup intent create.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.SetupIntentCreateParams{
      attach_to_self: boolean() | nil,
      automatic_payment_methods: map() | nil,
      confirm: boolean() | nil,
      confirmation_token: String.t() | nil,
      customer: String.t() | nil,
      customer_account: String.t() | nil,
      description: String.t() | nil,
      excluded_payment_method_types: [String.t()] | nil,
      expand: [String.t()] | nil,
      flow_directions: [String.t()] | nil,
      mandate_data: map() | nil,
      metadata: map() | nil,
      on_behalf_of: String.t() | nil,
      payment_method: String.t() | nil,
      payment_method_configuration: String.t() | nil,
      payment_method_data: map() | nil,
      payment_method_options: map() | nil,
      payment_method_types: [String.t()] | nil,
      return_url: String.t() | nil,
      single_use: map() | nil,
      usage: String.t() | nil,
      use_stripe_sdk: boolean() | nil
    }

- `attach_to_self` - 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.

- `automatic_payment_methods` - When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
- `confirm` - 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.
- `confirmation_token` - 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. Max length: 5000.

- `customer` - 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. Max length: 5000.

- `customer_account` - ID of the Account this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. Max length: 5000.

- `description` - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 1000.
- `excluded_payment_method_types` - The list of payment method types to exclude from use with this SetupIntent.
- `expand` - Specifies which fields in the response should be expanded.
- `flow_directions` - 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.

- `mandate_data` - This hash contains details about the mandate to create. This parameter can only be used with `confirm=true`.
- `metadata` - 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`.
- `on_behalf_of` - The Stripe account ID created for this SetupIntent.
- `payment_method` - ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. Max length: 5000.
- `payment_method_configuration` - The ID of the payment method configuration to use with this SetupIntent. Max length: 100.
- `payment_method_data` - When included, this hash creates a PaymentMethod that is set as the `payment_method` value in the SetupIntent.
- `payment_method_options` - Payment method-specific configuration for this SetupIntent.
- `payment_method_types` - The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.
- `return_url` - 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`.
- `single_use` - If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.

Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.

- `usage` - Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. Possible values: `off_session`, `on_session`.
- `use_stripe_sdk` - Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.