Search documentation of tiger_stripe

# Stripe.Params.PaymentIntentUpdateParams (tiger_stripe v0.1.1)

Copy Markdown View Source

Parameters for payment intent update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Stripe.Params.PaymentIntentUpdateParams{
      amount: integer() | nil,
      amount_details: map() | nil,
      application_fee_amount: map() | nil,
      capture_method: String.t() | nil,
      currency: String.t() | nil,
      customer: String.t() | nil,
      customer_account: String.t() | nil,
      description: String.t() | nil,
      excluded_payment_method_types: map() | nil,
      expand: [String.t()] | nil,
      hooks: map() | nil,
      metadata: map() | nil,
      payment_details: map() | 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,
      receipt_email: map() | nil,
      setup_future_usage: String.t() | nil,
      shipping: map() | nil,
      statement_descriptor: String.t() | nil,
      statement_descriptor_suffix: String.t() | nil,
      transfer_data: map() | nil,
      transfer_group: String.t() | nil
    }

- `amount` - Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- `amount_details` - Provides industry-specific information about the amount.
- `application_fee_amount` - The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.
- `capture_method` - Controls when the funds will be captured from the customer's account. Possible values: `automatic`, `automatic_async`, `manual`.
- `currency` - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
- `customer` - ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If setup_future_usage is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead. Max length: 5000.

- `customer_account` - ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.

Payment methods attached to other Accounts cannot be used with this PaymentIntent.

If setup_future_usage is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Account instead. 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 payment.
- `expand` - Specifies which fields in the response should be expanded.
- `hooks` - Automations to be run during the PaymentIntent lifecycle
- `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`.
- `payment_details` - Provides industry-specific information about the charge.
- `payment_method` - ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. Max length: 5000.
- `payment_method_configuration` - The ID of the payment method configuration to use with this PaymentIntent. Max length: 100.
- `payment_method_data` - If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.
- `payment_method_options` - Payment-method-specific configuration for this PaymentIntent.
- `payment_method_types` - The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.
- `receipt_email` - Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
- `setup_future_usage` - 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`. Possible values: `off_session`, `on_session`.

- `shipping` - Shipping information for this PaymentIntent.
- `statement_descriptor` - Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead. Max length: 22.

- `statement_descriptor_suffix` - Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. Max length: 22.
- `transfer_data` - Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.
- `transfer_group` - A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the use case for connected accounts.