@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

Returns a list of PaymentIntents.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return PaymentIntents for the customer that this customer ID specifies. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentFlowsPaymentIntentList]

<p>Returns a list of PaymentIntents.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return PaymentIntents for the customer that this customer ID specifies. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

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.

@required @param intent [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param client_secret [String?] The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. @return [Stripe::PaymentIntent]

<p>Retrieves the details of a PaymentIntent that has previously been created. </p> <p>You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. </p> <p>If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the <a href=&quot;#payment_intent_object&quot;>payment intent</a> object reference for more details.</p> @required @param intent [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param client_secret [String?] The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. @return nil

<p>Retrieves the details of a PaymentIntent that has previously been created. </p> <p>You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. </p> <p>If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the <a href=&quot;#payment_intent_object&quot;>payment intent</a> object reference for more details.</p> @required @param intent [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @optional @param client_secret [String?] The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

@required @param query [String?] The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SearchResult]

<p>Search for PaymentIntents you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for payment intents. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>Search for PaymentIntents you’ve previously created using Stripe’s <a href=&quot;/docs/search#search-query-language&quot;>Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p> @required @param query [String?] The search query string. See search query language and the list of supported query fields for payment intents. @optional @param page [String?] A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SearchResult, Integer, Hash)] Stripe::SearchResult, response status code and response headers

<p>Returns a list of PaymentIntents.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param customer [String?] Only return PaymentIntents for the customer that this customer ID specifies. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentFlowsPaymentIntentList, Integer, Hash)] Stripe::PaymentFlowsPaymentIntentList, response status code and response headers

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.

@required @param amount [Int32?] Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#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://stripe.com/docs/currencies#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). @required @param currency [String?] 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). @optional @param application_fee_amount [Int32?] 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://stripe.com/docs/payments/connected-accounts). @optional @param automatic_payment_methods [Stripe::AutomaticPaymentMethodsParam?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirm [Bool?] Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) 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](https://stripe.com/docs/api/payment_intents/confirm). @optional @param confirmation_method [String?] Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param 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 [setup_future_usage](https://stripe.com/docs/api#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#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param error_on_requires_action [Bool?] Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @optional @param mandate_data [Stripe::PostPaymentIntentsRequestMandateData?] @optional @param metadata [Hash(String, String)?] @optional @param off_session [Stripe::PostPaymentIntentsRequestOffSession?] @optional @param on_behalf_of [String?] The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\\\"card\\\"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [String?] 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](https://dashboard.stripe.com/account/emails). @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). @optional @param setup_future_usage [String?] 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](/payments/save-during-payment) 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](/api/payment_methods/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](/api/charges/object#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](/strong-customer-authentication). @optional @param shipping [Stripe::OptionalFieldsShipping?] @optional @param statement_descriptor [String?] 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). 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#dynamic) instead. @optional @param statement_descriptor_suffix [String?] Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. @optional @param transfer_data [Stripe::TransferDataCreationParams?] @optional @param transfer_group [String?] A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). @optional @param use_stripe_sdk [Bool?] Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return [Stripe::PaymentIntent]

<p>Creates a PaymentIntent object.</p> <p>After the PaymentIntent is created, attach a payment method and <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm</a> to continue the payment. Learn more about <a href=&quot;/docs/payments/payment-intents&quot;>the available payment flows with the Payment Intents API</a>.</p> <p>When you use <code>confirm=true</code> during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm API</a> when you supply <code>confirm=true</code>.</p> @required @param amount [Int32?] 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). @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param application_fee_amount [Int32?] 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. @optional @param automatic_payment_methods [Stripe::AutomaticPaymentMethodsParam?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirm [Bool?] 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. @optional @param confirmation_method [String?] Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param 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 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param error_on_requires_action [Bool?] Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. This parameter can only be used with confirm=true. @optional @param mandate_data [Stripe::PostPaymentIntentsRequestMandateData?] @optional @param metadata [Hash(String, String)?] @optional @param off_session [Stripe::PostPaymentIntentsRequestOffSession?] @optional @param on_behalf_of [String?] The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts. @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If you don't provide the payment_method parameter or the source parameter with confirm=true, source automatically populates with customer.default_source to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [String?] 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. @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true. @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::OptionalFieldsShipping?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataCreationParams?] @optional @param transfer_group [String?] A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts. @optional @param use_stripe_sdk [Bool?] Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return nil

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.

@required @param intent [String?] @optional @param amount [Int32?] Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#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://stripe.com/docs/currencies#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). @optional @param application_fee_amount [Stripe::PostPaymentIntentsIntentRequestApplicationFeeAmount?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param currency [String?] 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). @optional @param 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 [setup_future_usage](https://stripe.com/docs/api#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#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] 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](https://dashboard.stripe.com/settings/payment_methods). @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param setup_future_usage [String?] 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](/payments/save-during-payment) 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](/api/payment_methods/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](/api/charges/object#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](/strong-customer-authentication). 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`. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param statement_descriptor [String?] 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). 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#dynamic) instead. @optional @param statement_descriptor_suffix [String?] Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @optional @param transfer_group [String?] 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](https://stripe.com/docs/payments/connected-accounts). @return [Stripe::PaymentIntent]

<p>Updates properties on a PaymentIntent object without confirming.</p> <p>Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the <code>payment_method</code> 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 <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm API</a> instead.</p> @required @param intent [String?] @optional @param amount [Int32?] 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). @optional @param application_fee_amount [Stripe::PostPaymentIntentsIntentRequestApplicationFeeAmount?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param 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 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param payment_method [String?] 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. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] 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. @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @optional @param transfer_group [String?] 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. @return nil

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

@required @param intent [String?] @optional @param amount [Int32?] Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. @optional @param currency [String?] 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). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentIntent]

<p>Manually reconcile the remaining amount for a <code>customer_balance</code> PaymentIntent.</p> @required @param intent [String?] @optional @param amount [Int32?] Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the smallest currency unit (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>Manually reconcile the remaining amount for a <code>customer_balance</code> PaymentIntent.</p> @required @param intent [String?] @optional @param amount [Int32?] Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the smallest currency unit (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

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.

@required @param intent [String?] @optional @param cancellation_reason [String?] Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned` @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentIntent]

<p>You can cancel a PaymentIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code> or, <a href=&quot;/docs/payments/intents&quot;>in rare cases</a>, <code>processing</code>. </p> <p>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 <code>status</code> of <code>requires_capture</code>, the remaining <code>amount_capturable</code> is automatically refunded. </p> <p>You can’t cancel the PaymentIntent for a Checkout Session. <a href=&quot;/docs/api/checkout/sessions/expire&quot;>Expire the Checkout Session</a> instead.</p> @required @param intent [String?] @optional @param cancellation_reason [String?] Reason for canceling this PaymentIntent. Possible values are: duplicate, fraudulent, requested_by_customer, or abandoned @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>You can cancel a PaymentIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code> or, <a href=&quot;/docs/payments/intents&quot;>in rare cases</a>, <code>processing</code>. </p> <p>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 <code>status</code> of <code>requires_capture</code>, the remaining <code>amount_capturable</code> is automatically refunded. </p> <p>You can’t cancel the PaymentIntent for a Checkout Session. <a href=&quot;/docs/api/checkout/sessions/expire&quot;>Expire the Checkout Session</a> instead.</p> @required @param intent [String?] @optional @param cancellation_reason [String?] Reason for canceling this PaymentIntent. Possible values are: duplicate, fraudulent, requested_by_customer, or abandoned @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

@required @param intent [String?] @optional @param amount_to_capture [Int32?] The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. @optional @param application_fee_amount [Int32?] 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://stripe.com/docs/payments/connected-accounts). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param final_capture [Bool?] Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param statement_descriptor [String?] 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). 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#dynamic) instead. @optional @param statement_descriptor_suffix [String?] Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return [Stripe::PaymentIntent]

<p>Capture the funds of an existing uncaptured PaymentIntent when its status is <code>requires_capture</code>.</p> <p>Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.</p> <p>Learn more about <a href=&quot;/docs/payments/capture-later&quot;>separate authorization and capture</a>.</p> @required @param intent [String?] @optional @param amount_to_capture [Int32?] The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full amount_capturable if it's not provided. @optional @param application_fee_amount [Int32?] 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. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param final_capture [Bool?] Defaults to true. When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return nil

<p>Capture the funds of an existing uncaptured PaymentIntent when its status is <code>requires_capture</code>.</p> <p>Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.</p> <p>Learn more about <a href=&quot;/docs/payments/capture-later&quot;>separate authorization and capture</a>.</p> @required @param intent [String?] @optional @param amount_to_capture [Int32?] The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full amount_capturable if it's not provided. @optional @param application_fee_amount [Int32?] 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. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param final_capture [Bool?] Defaults to true. When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

@required @param intent [String?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param error_on_requires_action [Bool?] Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. @optional @param mandate_data [Stripe::PostPaymentIntentsIntentConfirmRequestMandateData?] @optional @param off_session [Stripe::PostPaymentIntentsIntentConfirmRequestOffSession?] @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. @optional @param setup_future_usage [String?] 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](/payments/save-during-payment) 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](/api/payment_methods/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](/api/charges/object#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](/strong-customer-authentication). 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`. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param use_stripe_sdk [Bool?] Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return [Stripe::PaymentIntent]

<p>Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If payment fails, the PaymentIntent transitions to the <code>requires_payment_method</code> status or the <code>canceled</code> status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the <code>succeeded</code> status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>). If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted using our <a href=&quot;/docs/stripe-js/reference#stripe-handle-card-payment&quot;>client SDKs</a> and the PaymentIntent’s <a href=&quot;#payment_intent_object-client_secret&quot;>client_secret</a>. After <code>next_action</code>s are handled by the client, no additional confirmation is required to complete the payment. If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the <code>requires_confirmation</code> state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the <code>canceled</code> state.</p> @required @param intent [String?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param error_on_requires_action [Bool?] Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. @optional @param mandate_data [Stripe::PostPaymentIntentsIntentConfirmRequestMandateData?] @optional @param off_session [Stripe::PostPaymentIntentsIntentConfirmRequestOffSession?] @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param use_stripe_sdk [Bool?] Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return nil

<p>Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If payment fails, the PaymentIntent transitions to the <code>requires_payment_method</code> status or the <code>canceled</code> status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the <code>succeeded</code> status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>). If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted using our <a href=&quot;/docs/stripe-js/reference#stripe-handle-card-payment&quot;>client SDKs</a> and the PaymentIntent’s <a href=&quot;#payment_intent_object-client_secret&quot;>client_secret</a>. After <code>next_action</code>s are handled by the client, no additional confirmation is required to complete the payment. If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the <code>requires_confirmation</code> state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the <code>canceled</code> state.</p> @required @param intent [String?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param error_on_requires_action [Bool?] Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. @optional @param mandate_data [Stripe::PostPaymentIntentsIntentConfirmRequestMandateData?] @optional @param off_session [Stripe::PostPaymentIntentsIntentConfirmRequestOffSession?] @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param use_stripe_sdk [Bool?] Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

@required @param intent [String?] @required @param amount [Int32?] The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. @optional @param application_fee_amount [Int32?] 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://stripe.com/docs/payments/connected-accounts). @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param statement_descriptor [String?] Text that appears on the customer's statement as the statement descriptor for a non-card or 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). @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return [Stripe::PaymentIntent]

<p>Perform an incremental authorization on an eligible <a href=&quot;/docs/api/payment_intents/object&quot;>PaymentIntent</a>. To be eligible, the PaymentIntent’s status must be <code>requires_capture</code> and <a href=&quot;/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported&quot;>incremental_authorization_supported</a> must be <code>true</code>.</p> <p>Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher <code>amount</code> provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.</p> <p>If the incremental authorization succeeds, the PaymentIntent object returns with the updated <a href=&quot;/docs/api/payment_intents/object#payment_intent_object-amount&quot;>amount</a>. If the incremental authorization fails, a <a href=&quot;/docs/error-codes#card-declined&quot;>card_declined</a> error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.</p> <p>Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.</p> <p>Learn more about <a href=&quot;/docs/terminal/features/incremental-authorizations&quot;>incremental authorizations</a>.</p> @required @param intent [String?] @required @param amount [Int32?] The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. @optional @param application_fee_amount [Int32?] 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param statement_descriptor [String?] Text that appears on the customer's statement as the statement descriptor for a non-card or 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return nil

<p>Perform an incremental authorization on an eligible <a href=&quot;/docs/api/payment_intents/object&quot;>PaymentIntent</a>. To be eligible, the PaymentIntent’s status must be <code>requires_capture</code> and <a href=&quot;/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported&quot;>incremental_authorization_supported</a> must be <code>true</code>.</p> <p>Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher <code>amount</code> provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.</p> <p>If the incremental authorization succeeds, the PaymentIntent object returns with the updated <a href=&quot;/docs/api/payment_intents/object#payment_intent_object-amount&quot;>amount</a>. If the incremental authorization fails, a <a href=&quot;/docs/error-codes#card-declined&quot;>card_declined</a> error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.</p> <p>Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.</p> <p>Learn more about <a href=&quot;/docs/terminal/features/incremental-authorizations&quot;>incremental authorizations</a>.</p> @required @param intent [String?] @required @param amount [Int32?] The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. @optional @param application_fee_amount [Int32?] 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @optional @param statement_descriptor [String?] Text that appears on the customer's statement as the statement descriptor for a non-card or 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

Verifies microdeposits on a PaymentIntent object.

@required @param intent [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. @optional @param descriptor_code [String?] A six-character code starting with SM present in the microdeposit sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentIntent]

<p>Verifies microdeposits on a PaymentIntent object.</p> @required @param intent [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. @optional @param descriptor_code [String?] A six-character code starting with SM present in the microdeposit sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>Verifies microdeposits on a PaymentIntent object.</p> @required @param intent [String?] @optional @param amounts [Array(Int32)?] Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. @optional @param descriptor_code [String?] A six-character code starting with SM present in the microdeposit sent to the bank account. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

<p>Updates properties on a PaymentIntent object without confirming.</p> <p>Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the <code>payment_method</code> 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 <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm API</a> instead.</p> @required @param intent [String?] @optional @param amount [Int32?] 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). @optional @param application_fee_amount [Stripe::PostPaymentIntentsIntentRequestApplicationFeeAmount?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param 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 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param payment_method [String?] 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. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] 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. @optional @param receipt_email [Stripe::PostPaymentIntentsIntentRequestReceiptEmail?] @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::PostPaymentIntentsIntentRequestShipping?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataUpdateParams?] @optional @param transfer_group [String?] 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. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers

<p>Creates a PaymentIntent object.</p> <p>After the PaymentIntent is created, attach a payment method and <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm</a> to continue the payment. Learn more about <a href=&quot;/docs/payments/payment-intents&quot;>the available payment flows with the Payment Intents API</a>.</p> <p>When you use <code>confirm=true</code> during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the <a href=&quot;/docs/api/payment_intents/confirm&quot;>confirm API</a> when you supply <code>confirm=true</code>.</p> @required @param amount [Int32?] 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). @required @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. @optional @param application_fee_amount [Int32?] 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. @optional @param automatic_payment_methods [Stripe::AutomaticPaymentMethodsParam?] @optional @param capture_method [String?] Controls when the funds will be captured from the customer's account. @optional @param confirm [Bool?] 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. @optional @param confirmation_method [String?] Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. @optional @param confirmation_token [String?] ID of the ConfirmationToken used to confirm this PaymentIntent. 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. @optional @param 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 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. @optional @param description [String?] An arbitrary string attached to the object. Often useful for displaying to users. @optional @param error_on_requires_action [Bool?] Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param mandate [String?] ID of the mandate that's used for this payment. This parameter can only be used with confirm=true. @optional @param mandate_data [Stripe::PostPaymentIntentsRequestMandateData?] @optional @param metadata [Hash(String, String)?] @optional @param off_session [Stripe::PostPaymentIntentsRequestOffSession?] @optional @param on_behalf_of [String?] The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts. @optional @param payment_method [String?] ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If you don't provide the payment_method parameter or the source parameter with confirm=true, source automatically populates with customer.default_source to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this PaymentIntent. @optional @param payment_method_data [Stripe::PaymentMethodDataParams?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. @optional @param radar_options [Stripe::RadarOptionsWithHiddenOptions?] @optional @param receipt_email [String?] 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. @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true. @optional @param setup_future_usage [String?] 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. @optional @param shipping [Stripe::OptionalFieldsShipping?] @optional @param statement_descriptor [String?] 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. @optional @param statement_descriptor_suffix [String?] 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. @optional @param transfer_data [Stripe::TransferDataCreationParams?] @optional @param transfer_group [String?] A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts. @optional @param use_stripe_sdk [Bool?] Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. @return [Tuple(Stripe::PaymentIntent, Integer, Hash)] Stripe::PaymentIntent, response status code and response headers