Search K
Appearance
A Transaction represents the primary record of money movement in our payment platform. It indicates whether a flow of funds is a payment, refund, or chargeback, and contains the essential data to track, audit, and manage the lifecycle of that financial event.
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier for the transaction (e.g., txn_9135XCDMXCFXCA918VHG664A). Use this value to retrieve, update, or reference the transaction in subsequent API calls. |
| type | string | The high-level category of the transaction. See Transaction Types below. |
| status | string | Indicates the current state of the transaction in its lifecycle. See Transaction Status below. |
| order_amount | integer | The total order amount in the smallest currency unit (e.g., cents for USD). For example, $100.00 would be 10000. |
| order_currency | string | The three-letter ISO currency code (e.g., USD, EUR) representing the transaction’s currency. |
| amount_authorized | integer | The total authorized amount (in the smallest currency unit). Reflects how much was initially authorized, even if only part of it is ultimately captured. |
| amount_captured | integer | The cumulative sum of all captures applied to this transaction. If partial captures occur, this value will increase until it matches the total authorized amount. |
| amount_voided | integer | The total amount voided from the initial authorization. Voids typically occur before funds are captured, canceling part or all of the authorization. |
| amount_refunded | integer | The total amount refunded to the customer after funds are captured. For REFUND transactions, this value should match the order_amount if it's a full refund. |
| external_id | string | A merchant-supplied reference (e.g., an order ID or UUID) linking this transaction to your internal systems. |
| updated_at | string | An ISO 8601-formatted timestamp (UTC) indicating when the transaction was last updated. Example: 2024-09-05T05:05:25Z. |