Increment an authorization
POST {{baseUrl}}/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. As with the
initial authorization, incremental authorizations may 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 is returned with the updated amount. If the incremental authorization fails, a card_declined error is returned, and no fields on the PaymentIntent or Charge are updated. The PaymentIntent object remains capturable for the previously authorized amount.
Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. Once captured, a PaymentIntent can no longer be incremented.
Learn more about incremental authorizations.
Request Body
[{"name"=>"amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"application_fee_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"statement_descriptor", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"transfer_data[amount]", "value"=>"<integer>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |