Skip to content

Transaction Concept

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 Descriptions

FieldTypeDescription
idstringThe unique identifier for the transaction (e.g., txn_9135XCDMXCFXCA918VHG664A). Use this value to retrieve, update, or reference the transaction in subsequent API calls.
typestringThe high-level category of the transaction. See Transaction Types below.
statusstringIndicates the current state of the transaction in its lifecycle. See Transaction Status below.
order_amountintegerThe total order amount in the smallest currency unit (e.g., cents for USD). For example, $100.00 would be 10000.
order_currencystringThe three-letter ISO currency code (e.g., USD, EUR) representing the transaction’s currency.
amount_authorizedintegerThe total authorized amount (in the smallest currency unit). Reflects how much was initially authorized, even if only part of it is ultimately captured.
amount_capturedintegerThe 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_voidedintegerThe total amount voided from the initial authorization. Voids typically occur before funds are captured, canceling part or all of the authorization.
amount_refundedintegerThe 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_idstringA merchant-supplied reference (e.g., an order ID or UUID) linking this transaction to your internal systems.
updated_atstringAn ISO 8601-formatted timestamp (UTC) indicating when the transaction was last updated. Example: 2024-09-05T05:05:25Z.

Transaction Types

  • PAYMENT: The standard transaction flow where a customer pays the merchant. Typically begins with authorization, followed by capture (partial or full).
  • REFUND: The return of funds to a customer for a previously captured payment. This transaction references the original payment and tracks the refunded amount.
  • CHARGEBACK: Initiated by the cardholder’s bank due to a dispute or fraud. Previously captured funds may be reversed, pending further investigation or resolution.

Transaction Statuses

  • AUTHORIZED: The transaction has been authorized, and funds are held but not captured. The hold remains until you capture, void, or the authorization expires.
  • DECLINED: The authorization was rejected due to insufficient funds, fraud checks, or other reasons. The actual reason will be provided in the Operation details.
  • VOIDED: The authorization was canceled before funds were captured. No money is transferred, and the cardholder’s authorized amount becomes immediately available again.
  • PARTIAL_CAPTURED: A portion of the authorized amount has been captured so far.
  • CAPTURED: The entire authorized amount is captured. The funds have been deducted from the cardholder's account and will be transferred to the merchant.
  • EXPIRED: The authorization window elapsed without capture or void, automatically releasing the hold on the funds.