description: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API.

:setup_future_usage :: :string

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.

:payment_method :: ExOAPI.Stripe.Schemas.PaymentMethod | :string

ID of the payment method used in this PaymentIntent.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:processing :: ExOAPI.Stripe.Schemas.PaymentIntentProcessing

If present, this property tells you about the processing state of the payment.

:capture_method :: :string

Controls when the funds will be captured from the customer's account.

:payment_method_options :: ExOAPI.Stripe.Schemas.PaymentIntentPaymentMethodOptions

Payment-method-specific configuration for this PaymentIntent.

::data :: ExOAPI.Stripe.Schemas.Charge

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:amount_received :: :integer

Amount that was collected by this PaymentIntent.

:metadata :: :map

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. For more information, see the documentation.

:description :: :string

An arbitrary string attached to the object. Often useful for displaying to users.

::payment_method_types :: :string

:amount_capturable :: :integer

Amount that can be captured from this PaymentIntent.

:review :: ExOAPI.Stripe.Schemas.Review | :string

ID of the review associated with this PaymentIntent, if any.

:confirmation_method :: :string

:next_action :: ExOAPI.Stripe.Schemas.PaymentIntentNextAction

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

:on_behalf_of :: ExOAPI.Stripe.Schemas.Account | :string

The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

ID of the Customer this PaymentIntent belongs to, if one exists.

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

If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

:amount :: :integer

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).

:invoice :: ExOAPI.Stripe.Schemas.Invoice | :string

ID of the invoice that created this PaymentIntent, if it exists.

:automatic_payment_methods :: ExOAPI.Stripe.Schemas.PaymentFlowsAutomaticPaymentMethodsPaymentIntent

Settings to configure compatible payment methods from the Stripe Dashboard

:statement_descriptor :: :string

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

:application :: ExOAPI.Stripe.Schemas.Application | :string

ID of the Connect application that created the PaymentIntent.

:client_secret :: :string

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs to accept a payment and learn about how client_secret should be handled.

:receipt_email :: :string

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.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:last_payment_error :: ExOAPI.Stripe.Schemas.ApiErrors

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

:canceled_at :: :integer

Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:cancellation_reason :: :string

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

:status :: :string

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.

:transfer_group :: :string

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

:application_fee_amount :: :integer

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 payment amount. For more information, see the PaymentIntents use case for connected accounts.

:statement_descriptor_suffix :: :string

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

:transfer_data :: ExOAPI.Stripe.Schemas.TransferData

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

:id :: :string

Unique identifier for the object.

:shipping :: ExOAPI.Stripe.Schemas.Shipping

Shipping information for this PaymentIntent.