Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

Parameters

• amountintegerRequired

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

• currencyenumRequired

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

• automatic_payment_methodsassociative array

  When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent’s other parameters.

  Show child parameters

• confirmboolean

  Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.

• customerstring

  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.

• descriptionstring

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

• metadataassociative array

  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.

• off_sessionboolean | stringonly when confirm=true

  Set to true to indicate that the customer isn’t in your checkout flow during this payment attempt and can’t authenticate. Use this parameter in scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

• payment_methodstring

  ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.

  If you omit this parameter with confirm=true, customer.default_source attaches as this PaymentIntent’s payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward.

• receipt_emailstring

  Email address to send the receipt to. If you specify receipt_email for a payment in live mode, you send a receipt regardless of your email settings.

• setup_future_usageenum

  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.

  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.

• shippingassociative array

  Shipping information for this PaymentIntent.

  Show child parameters

• statement_descriptorstring

  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.

• statement_descriptor_suffixstring

  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.

More parameters

Expand all

• application_fee_amountintegerConnect only

• capture_methodenum

• confirmation_methodenum

• confirmation_tokenstringonly when confirm=true

• error_on_requires_actionbooleanonly when confirm=true

• mandatestringonly when confirm=true

• mandate_dataassociative arrayonly when confirm=true

• on_behalf_ofstringConnect only

• payment_method_configurationstring

• payment_method_dataassociative array

• payment_method_optionsassociative array

• payment_method_typesarray of strings

• radar_optionsassociative array

• return_urlstringonly when confirm=true

• transfer_dataassociative arrayConnect only

• transfer_groupstringConnect only

• use_stripe_sdkboolean

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Parameters

• amountinteger

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

• currencyenum

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

• customerstring

  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.

• descriptionstring

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

• metadataassociative array

  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_methodstring

  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.

• receipt_emailstring

  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_usageenum

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

• shippingassociative array

  Shipping information for this PaymentIntent.

  Show child parameters

• statement_descriptorstring

  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.

• statement_descriptor_suffixstring

  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.

More parameters

Expand all

• application_fee_amountintegerConnect only

• capture_methodenumsecret key only

• payment_method_configurationstring

• payment_method_dataassociative array

• payment_method_optionsassociative array

• payment_method_typesarray of strings

• transfer_dataassociative arrayConnect only

• transfer_groupstringConnect only

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Parameters

• client_secretstringRequired if you use a publishable key.

  The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.

Returns a list of PaymentIntents.

Parameters

• customerstring

  Only return PaymentIntents for the customer that this customer ID specifies.

More parameters

Expand all

• createdassociative array

• ending_beforestring

• limitinteger

• starting_afterstring

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Parameters

• cancellation_reasonstring

  Reason for canceling this PaymentIntent. Possible values are: duplicate, fraudulent, requested_by_customer, or abandoned