POST /v1/payment_intents/{intent}/increment_authorization
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.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
intent |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
description |
String | No |
An arbitrary string attached to the object. Often useful for displaying to users. |
amount |
Integer | Yes |
The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
application_fee_amount |
Integer | No |
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts. |
metadata |
Object | No |
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 |
statement_descriptor |
String | No |
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. |
transfer_data |
Object | No |
The parameters used to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts. |
transfer_data.amount |
Integer | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.