This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Structured field bundle for the
`IncrementalAuthorization`
operation. An incremental authorization sends a fresh auth message to the
brand network on top of the existing approved hold, increasing the held amount by the
requested increment. The issuer can decline.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
incrementalAmountrequired
number (double)
The additional authorization amount to request, in major currency units (e.g. `10.00`
= $10). The new `Total_Auth_Amt` after a successful incremental auth equals the
existing approved amount plus this value. Must be strictly positive: clearing or
reducing an existing hold is the reversal flow's job, not this one.greater than 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
reasonrequired
string
Optional caller-supplied reason / merchant note (e.g. `"Estimated tab plus 20% tip"`).
Surfaced on the close-stage history entry and the customer-facing receipt. Not validated
against any controlled vocabulary: purely informational.
Conditional: When Reason is not empty. Max length: 500.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isEmptyrequired
boolean
`true` when the bundle carries no actionable information. An
incremental authorization with a non-positive increment has nothing to ask the
brand for and is a caller error, rejected before anything is sent to the processor.read only
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.