Transaction Operation Schema
Individual processing actions and lifecycle events for transactions
The Transaction Operation schema defines the structure and properties of transaction operation objects in the Payload API. Transaction operations represent individual processing actions performed on transactions, tracking the operation type, amount, status, and relationship to the parent transaction for comprehensive transaction lifecycle management.
Transaction Operation Object Properties
Complete reference for all properties available in the Transaction Operation schema
amountnumber (double)
The monetary amount associated with this operation. This represents the amount of funds that were authorized, processed, captured, voided, or adjusted to.
attrsobject
Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.
created_atstring (date-time)Read-only
Timestamp when the resource was created. Automatically set by the system and immutable.
idstringRead-only
Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: op)
Pattern:
^op_[A-Za-z0-9]+$modified_atstring (date-time)Read-only
Timestamp when the resource was last modified. Automatically updated whenever any field changes.
objectenum[string]Read-only
String representing the object type for this resource.
Values:
transaction_operationstatusenum[string]
The current status of this operation. Possible values are: complete (operation completed successfully), failed (operation failed), or unknown (operation status could not be determined).
Values:
complete, failed, unknowntransaction_id ID of TransactionstringRequired
ID of the [Transaction](/apis/object-reference/transactions) object (ID prefix: txn)
Pattern:
^txn_[A-Za-z0-9]+$typeenum[string]
The type of operation performed on the transaction. Possible values are: authorize (pre-authorize funds), process (process the transaction), finalize (capture funds), void (cancel the transaction), reject (transaction rejected/failed), clear (captured funds have cleared), adjust (adjust transaction amount), or overturn (reverse a chargeback).
Values:
authorize, process, finalize, void, reject, clear, adjust, overturn