operationType
required |
TransactionOperationType
TransactionOperationType |
The type of operation to execute (e.g., Refund, Reversal, Void, Capture).
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.
Capture |
Finalizes a previously-approved authorization by sending an online capture / clearing message to the processor. Moves the transaction from "funds held" to "marked for the next batch close": settlement still happens later when the merchant's batch cuts. Valid only against approved, uncaptured TransactionType.Authorization transactions; the action matrix removes Capture once the transaction is settled (Refund is the post-settlement undo). Partial captures (less than the authorized amount) are supported and release the unused portion of the issuer hold per network rules. | Refund |
Returns funds to the cardholder by spawning a new standalone TransactionType.Return transaction linked back to the parent via OriginalTransaction.TransactionId. The new transaction flows through the normal auth + settlement pipeline rather than mutating the parent in place. Used once the parent has settled (post-batch-close), at which point Reversal and Void are no longer applicable. Refund capacity is reserved against the parent's PendingRefundAmount with optimistic concurrency so concurrent partial refunds from different callers cannot collectively exceed the parent's available balance. | Void |
Offline ledger-only cancel: marks the transaction for exclusion from the next batch close without sending any processor message. Used pre-settlement. Acts as the fallback when the configured processor does not support online Reversal (or the reversal window has expired). The action evaluator's mutual-exclusion step drops Void from the candidate set when Reversal is also eligible: Reversal is a strict superset of Void on the same stage. Terminal once approved. | Reversal |
Online undo: sends a processor message (0420-equivalent on card networks) that releases the issuer hold on a captured-but-not-cleared transaction and pulls the transaction from the next clearing. Distinct from Void in that an actual rails-level message is exchanged with the processor; the processor can decline. Eligible post-auth and pre-settlement against Authorization, Sale, RepeatSale, and captured Authorization stages. Per-processor support is advertised via ProcessorCapabilities.SupportsReversal and gated by ReversalWindowSeconds; the gateway falls back to Void when the processor opts out. Partial reversals (strictly less than the remaining authorized balance) are supported when the processor also advertises SupportsPartialReversal; a partial reversal leaves the transaction non-terminal until cumulative reversed equals the authorized ceiling. Once settlement has cleared, Reversal is no longer valid and Refund is the only available undo. | Repeat |
Re-runs a previously-approved transaction with the same payment data by spawning a new transaction linked back to the parent via OriginalTransaction.TransactionId. Authorizations repeat as Authorization (re-hold funds); Sale and RepeatSale both repeat as RepeatSale. Used for recurring billing, card-on-file scenarios, and operator-initiated re-charges. The caller may supply a different amount than the original; the new transaction flows through the normal auth + settlement pipeline. Available against approved transactions in any settlement state: once an authorization has settled, Repeat is the only re-charge path (Capture is no longer eligible). | Retry |
Re-attempts a previously declined or failed transaction with the same TransactionType and the same amount as the original: changing either would violate retry semantics. Spawns a new transaction linked back to the parent via OriginalTransaction.TransactionId. Available only when the parent ended in a non-approved result code (decline, processing error, gateway failure). Distinct from Repeat, which preserves type-mapping rules (Sale → RepeatSale) and allows a caller-specified amount; Retry is intended to recover from a transient failure on the original attempt without altering its commercial intent. | OfflineAdjustment |
An offline adjustment to a previously-authorized transaction's settlement record: tip (gratuity), tax, level-3 data, PO number, or AVS fields. Modifies the settlement amount/data before batch close without contacting the processor network. Tip and other amount-bearing fields are constrained to industry types that allow post-auth adjustments (restaurant, retail, e-commerce). Online amount changes (incremental authorization) belong to IncrementalAuthorization. | IncrementalAuthorization |
An online incremental (or "estimated → final") authorization on top of a previously authorized (but uncaptured) transaction. The processor sends a fresh auth message to the brand network; on approve, the transaction's Total_Auth_Amt is bumped and a new auth response (with its own customer-facing receipt) replaces the prior one. Distinct from OfflineAdjustment in that an actual rails round-trip is performed and the issuer can decline. Valid only against TransactionType.Authorization transactions that have not yet been captured. Per-processor support is advertised via ProcessorCapabilities.SupportedAdjustmentTypes; the gateway rejects the operation up front when the configured processor lacks the capability. | AcceptPartialApproval |
Acknowledges a partial approval by keeping the reduced authorization as-is. The issuer approved less than the gateway asked for, and the operator (or the cardholder) has decided the lesser amount is acceptable, so no reversal is issued and the transaction proceeds through the normal capture / settlement path for the approved amount. Valid only while the transaction is parked at TransactionStage.SplitTenderPending with PartialApprovalData.Disposition still Pending; a late acknowledgment against a disposition the deadline sweep has already resolved is expected traffic and is rejected. Its counterpart is Void, which rejects the reduced amount instead. | SplitTender |
Acknowledges a partial approval by keeping the reduced authorization and collecting the shortfall on a second tender. The continuation transaction carries the same SplitTenderGroupId with the next SplitTenderSequence. Valid only while the transaction is parked at TransactionStage.SplitTenderPending, and only when the merchant permits split tender and the group has not reached VirtualTerminalSettings.SplitTenderMaxTenders. |
|
amount
required |
number (double)
|
Optional amount for partial operations (refund, reversal). What an omitted value means
differs by operation, so it is stated per operation rather than as one rule.
Conditional: When Amount 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.
|
reason
required |
string
|
Optional reason or note for the operation.
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.
|
idempotencyKey
required |
string
|
Optional caller-supplied idempotency key used to deduplicate a retried operation
(reversal, void, capture, refund, repeat, retry) after a network timeout. The key is
scoped to a single merchant + transaction + operation: submitting the same operation
twice with the same key executes once and the second call returns the original
operation's outcome (for a spawning operation, the same child transaction id) instead
of re-applying it.
Conditional: When IdempotencyKey is not empty. Max length: 128.
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.
|
offlineAdjustment
required |
OfflineAdjustmentFields
OfflineAdjustmentFields |
Structured field bundle for the
`OfflineAdjustment`
operation. Required when `operationType` is
`OfflineAdjustment`; rejected by the input validator for any other operation
type so the wrong shape cannot ride along quietly.
Required: When OperationType == OfflineAdjustment.
Conditional: When OfflineAdjustment is not null.
Conditional: When OperationType != OfflineAdjustment.
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 of OfflineAdjustmentFields:
| Field |
Type |
Description |
|---|
tipAmount
required |
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.
| taxAmount
required |
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.
| level3Amount
required |
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.
| poNumber
required |
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.
| billingStreet
required |
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.
| billingZip
required |
string
|
Replacement AVS postal/ZIP value. Settlement-only field: paired with
`billingStreet`.
<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.
| isEmpty
required |
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.
| isTipOnly
required |
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 body has no documented fields. |
incrementalAuthorization
required |
IncrementalAuthorizationFields
IncrementalAuthorizationFields |
Structured field bundle for the
`IncrementalAuthorization`
operation. Required when `operationType` is
`IncrementalAuthorization`; rejected by the input validator for any other
operation type so the wrong shape cannot ride along quietly.
Required: When OperationType == IncrementalAuthorization.
Conditional: When IncrementalAuthorization is not null.
Conditional: When OperationType != IncrementalAuthorization.
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 of IncrementalAuthorizationFields:
| Field |
Type |
Description |
|---|
incrementalAmount
required |
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.
| reason
required |
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.
| isEmpty
required |
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 body has no documented fields. |
initiationType
required |
InitiationType
InitiationType |
Classification gate for `Repeat`. The caller
must declare whether the new charge is being initiated by the cardholder (CIT:
cardholder is present and authorizing this specific re-run) or by the merchant
(MIT: under prior consent or as a network resubmission of a declined attempt).
Required: When OperationType == Repeat.
Conditional: When InitiationType is not null.
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.
CardholderInitiated |
The cardholder is present or otherwise authorizing this specific charge contemporaneously. Default for transactions originated by the cardholder through HPP checkout, API with cardholder interaction, or virtual terminal sales with the cardholder present. | MerchantInitiated |
The merchant is initiating this charge without contemporaneous cardholder authorization, relying on prior consent captured on an earlier cardholder-initiated transaction. Used for recurring billing, unscheduled credential-on-file charges, resubmissions, and other merchant-triggered uses of a stored credential. |
|
mitReason
required |
MITReasonCode
MITReasonCode |
MIT reason code (Recurring, UnscheduledCOF, Resubmission, etc.) accompanying
`initiationType` when it is
`MerchantInitiated`.
Required: When OperationType == Repeat and InitiationType == MerchantInitiated.
Conditional: When MITReason is not null.
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.
Recurring |
Fixed or variable charges on a scheduled basis for a subscription or ongoing service the cardholder has enrolled in. | Installment |
A series of charges dividing a known total amount over a defined schedule. | UnscheduledCOF |
Charges triggered by a specific, pre-agreed event (e.g. account balance threshold, usage overage). Not on a schedule. | Resubmission |
Recharging after a declined or reversed transaction, in accordance with card network resubmission rules. Must be for the same amount as the original declined attempt and within the network's permitted resubmission window. | Reauthorization |
Re-authorizing a prior authorization (e.g. when the original authorization has expired but the merchant still intends to capture). | DelayedCharge |
A charge finalized after the cardholder's original authorization (e.g. tip adjustment, additional services added after checkout, or final amounts determined after service completion). | NoShow |
No-show or cancellation fee where the cardholder made a reservation or booking and failed to cancel within the required window. | IncrementalAuth |
Additional authorization on top of a prior authorization (e.g. hotel incidentals, car rental overages). |
|
storedCredentialConsentId
required |
string (uuid)
|
Identifier of the `StoredCredentialConsent` record that authorizes this MIT.
Required for non-resubmission MITs (Recurring, UnscheduledCOF, NoShow, DelayedCharge,
Installment, Reauthorization, IncrementalAuth). Ignored for
`Resubmission`: resubmissions are authorized by card-network
resubmission rules rather than by a consent record.
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.
|