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 OfflineAdjustment operation. Each property is optional;
only the populated fields are applied to the transaction's settlement record and to the
transaction.
"Offline" means the adjustment is applied to the transaction's settlement record without
contacting the card network. Eligible fields are the tip, tax amount, Level 3 amount,
purchase order number, street and ZIP code; changing any other field requires a new
authorization. A tip adjustment is accepted only when the merchant's industry permits tips.
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
tipAmountrequired
number (double)
Replacement gratuity in major currency units (e.g. `5.00` = $5.00). Mutates the
settlement `<Gratuity>` and `<SettlementAmount>` elements and
patches the transaction document's `/InvoiceData/Amounts/Tip` field when
populated. `0` is interpreted as "clear the existing tip". The transaction's
`Total` is intentionally not patched: `TrxAmounts.Total` is a computed
property (`Base + Tip + Tax + Shipping + Convenience`) re-derived on every
hydration, so the new tip flows through to the displayed Total automatically without
a stored mutation.
<b>Wired today.</b>
Conditional: When TipAmount is not null. Must be >= 0.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.
taxAmountrequired
number (double)
Replacement tax amount in major currency units. Settlement-only field: does not affect
the transaction's running total. Used for interchange-rate qualification on the batch.
<b>Not yet implemented.</b>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.
level3Amountrequired
number (double)
Replacement level-3 line-item subtotal in major currency units. Settlement-only field
for level-3 (commercial card / GSA) interchange-rate qualification.
<b>Not yet implemented.</b>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.
poNumberrequired
string
Replacement purchase-order number. Settlement-only field for level-3 / level-2
commercial-card data.
<b>Not yet implemented.</b>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.
billingStreetrequired
string
Replacement AVS street value. Settlement-only field: used for retro AVS attachment
when the original auth was processed without AVS.
<b>Not yet implemented.</b>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.
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 no fields are populated. An empty bundle is a caller
error: the OfflineAdjustment operation has nothing to apply.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.
isTipOnlyrequired
boolean
`true` when only `tipAmount` is populated (or no fields,
but `isEmpty` would be checked first). Used by the contributor to
short-circuit the non-tip wiring path that does not yet exist.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.