OrderTransactionKind

An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.

A transfer of the money that was reserved by an authorization.

The money returned to the customer when they've paid too much during a cash transaction.

An authorization for a payment taken with an EMV credit card reader.

A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

An authorization and capture performed together in a single step.

A suggested refund transaction that can be used to create a refund.

A cancelation of an authorization transaction.

The input fields for a transaction to create for an order.

The OrderTransaction 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 OrderTransaction 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 OrderTransaction 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 OrderTransaction object has a kind that defines the type of transaction and a status 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.

The input fields for the information needed to create an order transaction.