Order Transaction Status
The different states that an can have.
Anchor to Valid valuesValid values
- Anchor to AWAITING_RESPONSEAWAITING_
RESPONSE Awaiting a response.
- Anchor to ERRORERROR
There was an error while processing the transaction.
- Anchor to FAILUREFAILURE
The transaction failed.
- Anchor to PENDINGPENDING
The transaction is pending.
- Anchor to SUCCESSSUCCESS
The transaction succeeded.
- Anchor to UNKNOWNUNKNOWN
The transaction status is unknown.
Anchor to FieldsFields
- •INPUT OBJECT
The input fields for a transaction to create for an order.
- •OBJECT
The
object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity.
Use the
object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using the
object include:
- Processing new payments for orders
- Managing payment authorizations and captures
- Processing refunds for returned items
- Tracking payment status and errors
- Managing multi-currency transactions
- Handling payment gateway integrations
Each
object has a
kind
that defines the type of transaction and astatus
that indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details.Learn more about payment processing and payment gateway integrations.