Incremental Authorization

Overview

The incrementalAuthorization method increases the authorized amount on an existing authorization that is still in AUTHORIZED status. Use this for hospitality, tips, or add-on charges.

Business Use Case: A hotel guest adds room service charges to their folio. Increase the authorization hold to cover the additional charges.

Purpose

Scenario
Benefit

Hotel incidentals

Add room service, mini-bar charges

Restaurant tips

Add post-dining tip

Add-on services

Cover additional costs

Metered services

Extend hold for actual usage

Request Fields

Field
Type
Required
Description

merchantAuthorizationId

string

Yes

Your unique incremental auth ID

connectorTransactionId

string

Yes

Original authorization ID

amount

Money

Yes

New total amount (not incremental amount)

reason

string

No

Reason for increase

Response Fields

Field
Type
Description

connectorAuthorizationId

string

Connector's authorization ID

status

AuthorizationStatus

AUTHORIZED, FAILED

error

ErrorInfo

Error details if failed

statusCode

number

HTTP status code

Example

SDK Setup

Request

Response

Important Notes

  • The authorization must have incrementalAuthorizationAllowed: true

  • Pass the new total amount, not the incremental amount

  • Can only increase while in AUTHORIZED status

Next Steps

  • authorize - Create initial authorization (set requestIncrementalAuthorization: true)

  • capture - Finalize with increased amount

Last updated

Was this helpful?