Skip to main content

Incremental authorization

We are improving our documentation

We're currently working on improving this page to provide you with the best possible experience. Please bear with us while we make some changes.

Thank you for your patience!

An incremental authorization increases the authorized amount on the customer's payment instrument.

Currently, the incremental authorization is only supported by a few adapters.

A following capture transaction may capture the full amount of the initial transaction and all its subsequent incremental authorizations.

Note: The capture transaction must refer to the initial preauthorize!

POST /transaction/{apiKey}/incrementalAuthorization

Path parameters

NameTypeDescription
apiKeyrequiredstringAPI Key of Connector
Request body example
{
"cardData": {
"cardHolder": "Alex Smith",
"pan": "4111111111111111",
"cvv": "123",
"expirationMonth": "5",
"expirationYear": "2029"
},
"merchantTransactionId": "your-unique-identifier",
"referenceUuid": "4d40738b1194869734f7",
"merchantMetaData": "my-category-1",
"amount": "9.99",
"currency": "EUR",
"successUrl": "https://shop.example.org/checkout/success",
"cancelUrl": "https://shop.example.org/checkout/cancelled",
"errorUrl": "https://shop.example.org/checkout/error",
"callbackUrl": "https://api.example.org/callback",
"description": "Purchase description shown on credit card statement."
}