# The PaymentIntent object ### The PaymentIntent object ```json { "id": "pi_3MtwBwLkdIwHu7ix28a3tqPa", "object": "payment_intent", "amount": 2000, "amount_capturable": 0, "amount_details": { "tip": {} }, "amount_received": 0, "application": null, "application_fee_amount": null, "automatic_payment_methods": { "enabled": true }, "canceled_at": null, "cancellation_reason": null, "capture_method": "automatic", "client_secret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH", "confirmation_method": "automatic", "created": 1680800504, "currency": "usd", "customer": null, "description": null, "invoice": null, "last_payment_error": null, "latest_charge": null, "livemode": false, "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": null, "payment_method_options": { "card": { "installments": null, "mandate_options": null, "network": null, "request_three_d_secure": "automatic" }, "link": { "persistent_token": null } }, "payment_method_types": [ "card", "link" ], "processing": null, "receipt_email": null, "review": null, "setup_future_usage": null, "shipping": null, "source": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "requires_payment_method", "transfer_data": null, "transfer_group": null } ``` ## Attributes - `id` (string) Unique identifier for the object. - `object` (string) String representing the object’s type. Objects of the same type share the same value. - `amount` (integer) Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/docs/currencies.md#zero-decimal) (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](https://docs.stripe.com/docs/currencies.md#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - `amount_capturable` (integer) Amount that can be captured from this PaymentIntent. - [`amount_details`](https://docs.stripe.com/api/payment_intents/object.md?query=amount_details) (object, nullable) Provides industry-specific information about the amount. - `amount_received` (integer) Amount that this PaymentIntent collects. - `application` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) ID of the Connect application that created the PaymentIntent. - `application_fee_amount` (integer, nullable) 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](https://docs.stripe.com/docs/payments/connected-accounts.md). - [`automatic_payment_methods`](https://docs.stripe.com/api/payment_intents/object.md?query=automatic_payment_methods) (object, nullable) Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) - `canceled_at` (timestamp, nullable) Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. - `cancellation_reason` (enum, nullable) 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`). Possible enum values: - `abandoned` - `automatic` - `duplicate` - `failed_invoice` - `fraudulent` - `requested_by_customer` - `void_invoice` - `capture_method` (enum) Controls when the funds will be captured from the customer’s account. Possible enum values: - `automatic` Stripe automatically captures funds when the customer authorizes the payment. - `automatic_async` (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over `capture_method=automatic` due to improved latency. Read the [integration guide](https://docs.stripe.com/docs/payments/payment-intents/asynchronous-capture.md) for more information. - `manual` Place a hold on the funds when the customer authorizes the payment, but [don’t capture the funds until later](https://docs.stripe.com/docs/payments/capture-later.md). (Not all payment methods support this.) - `client_secret` (string, nullable) 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](https://docs.stripe.com/docs/payments/accept-a-payment.md?ui=elements) and learn about how `client_secret` should be handled. - `confirmation_method` (enum) Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. Possible enum values: - `automatic` (Default) PaymentIntent can be confirmed using a publishable key. After `next_action`s are handled, no additional confirmation is required to complete the payment. - `manual` All payment attempts must be made using a secret key. The PaymentIntent returns to the `requires_confirmation` state after handling `next_action`s, and requires your server to initiate each payment attempt with an explicit confirmation. - `created` (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` (enum) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - `customer` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) 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](https://docs.stripe.com/api/payment_intents/object.md#payment_intent_object-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](https://docs.stripe.com/api/charges/object.md#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - `description` (string, nullable) An arbitrary string attached to the object. Often useful for displaying to users. - `invoice` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) ID of the invoice that created this PaymentIntent, if it exists. - [`last_payment_error`](https://docs.stripe.com/api/payment_intents/object.md?query=last_payment_error) (object, nullable) The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. - `latest_charge` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) ID of the latest [Charge object](https://docs.stripe.com/docs/api/charges.md) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. - `livemode` (boolean) Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - `metadata` (object) Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata.md) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/docs/payments/payment-intents/creating-payment-intents.md#storing-information-in-metadata). - [`next_action`](https://docs.stripe.com/api/payment_intents/object.md?query=next_action) (object, nullable) 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` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/docs/payments/connected-accounts.md) for details. - `payment_method` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) ID of the payment method used in this PaymentIntent. - [`payment_method_configuration_details`](https://docs.stripe.com/api/payment_intents/object.md?query=payment_method_configuration_details) (object, nullable) Information about the [payment method configuration](https://docs.stripe.com/docs/api/payment_method_configurations.md) used for this PaymentIntent. - [`payment_method_options`](https://docs.stripe.com/api/payment_intents/object.md?query=payment_method_options) (object, nullable) Payment-method-specific configuration for this PaymentIntent. - `payment_method_types` (array of strings) The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. - [`processing`](https://docs.stripe.com/api/payment_intents/object.md?query=processing) (object, nullable) If present, this property tells you about the processing state of the payment. - `receipt_email` (string, nullable) 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](https://dashboard.stripe.com/account/emails). - `review` (string, nullable, expandable (can be expanded into an object with the `expand` request parameter)) ID of the review associated with this PaymentIntent, if any. - `setup_future_usage` (enum, nullable) 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](https://docs.stripe.com/payments/save-during-payment.md) 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](https://docs.stripe.com/api/payment_methods/attach.md) 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](https://docs.stripe.com/api/charges/object.md#charge_object-payment_method_details-card_present-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](https://docs.stripe.com/strong-customer-authentication.md). Possible enum values: - `off_session` Use `off_session` if your customer may or may not be present in your checkout flow. - `on_session` Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow. - [`shipping`](https://docs.stripe.com/api/payment_intents/object.md?query=shipping) (object, nullable) Shipping information for this PaymentIntent. - `statement_descriptor` (string, nullable) 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](https://docs.stripe.com/get-started/account/statement-descriptors.md). Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors.md#dynamic) instead. - `statement_descriptor_suffix` (string, nullable) Provides information about a card charge. Concatenated to the account’s [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors.md#static) to form the complete statement descriptor that appears on the customer’s statement. - `status` (enum) 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](https://docs.stripe.com/docs/payments/intents.md#intent-statuses). Possible enum values: - `canceled` - `processing` - `requires_action` - `requires_capture` - `requires_confirmation` - `requires_payment_method` - `succeeded` - [`transfer_data`](https://docs.stripe.com/api/payment_intents/object.md?query=transfer_data) (object, nullable) The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/docs/payments/connected-accounts.md). - `transfer_group` (string, nullable) A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/docs/connect/separate-charges-and-transfers.md).