Incremental Authorization
Incremental Authorization increases the locked amount of funds in an existing Pre-Authorization for later settle by a single Pre-Authorization Completion.
1. Getting Started with Incremental Authorization
Incremental Authorization increases the locked amount of funds in an existing Pre-Authorization for later settle by a single Pre-Authorization Completion. There is no limit to the number of incremental Pre-Authorization transactions on the original estimated Authorization and each new incremental Pre-Authorization increases the hold on the customer's credit card.
For Mastercard only, an Incremental Pre-Authorization can be submitted with a $0 value for the amount to request extending the allowable timeframe for completion (e.g, 30 days).
2. Create Payment using Incremental Authorization
Incremental Pre-Authorizations can be performed using the Create Payment API call (POST request on /payments). Some key things to note about an Incremental Pre-Authorization transaction include:
automaticCapture (Boolean)
This must be set to FALSE for Incremental Pre-Authorization transactions.
incrementalAuthorization.incrementalAuthorizationIndicator (Boolean)
This must be set to TRUE for Incremental Pre-Authorization transactions.
3. Increment Payment
The Increment Payment API call can be used to increase the locked amount of funds in an existing Pre-Authorization that was performed with incrementalAuthorizationIndicator set to true. This can be performed by a POST request on /payments/{payment-id}/increment. Some key things to note about the Increment Payment API call include:
amount (Object):
This specifies the amount to be added to the existing Pre-Authorization.
amount: Integer value in cents (e.g., $10.59 → 1059)
currency: ISO currency code (e.g., CAD, USD)
4. Complete Payment
The Complete Payment API call can be used to complete the locked amount of funds pertaining to an Incremental Pre-Authorization. This can be performed by a POST request on /payments/{payment-id}/complete. Some key things to note about the Complete Payment API call include:
amount (Object):
This specifies the amount to be added to the existing Pre-Authorization.
amount: Integer value in cents (e.g., $10.59 → 1059)
currency: ISO currency code (e.g., CAD, USD)
Additional Information
Learn more with the API Definitions
Peruse the endpoints, request/response formats, and authentication methods covered in this scenario.
.svg)