TransactionEvent

High-level transaction event details.

Fields

  • idinteger
    format: int64

    Numeric identifier of a transaction event. Use it as tx_event_id when requesting receipt details for a specific event. This is separate from the transaction ID and the transaction history pagination references.

    Example: 9567461191

  • Unique identifier of the transaction.

    Example: "410fc44a-5956-44e1-b5cc-19c6f8d727a4"

  • typestring
    Options:"PAYOUT""CHARGE_BACK""REFUND""PAYOUT_DEDUCTION"

    Financial event associated with a transaction.

    • PAYOUT: Funds from the transaction being prepared for or included in a merchant payout. Check the event status to determine whether they have been paid out.
    • REFUND: Money returned to the payer.
    • CHARGE_BACK: A reversal of the payment following a chargeback.
    • PAYOUT_DEDUCTION: An amount deducted from a merchant payout, for example to cover a refund or chargeback.

    Example: "REFUND"

  • statusstring
    Options:"FAILED""PAID_OUT""PENDING""RECONCILED""REFUNDED""SCHEDULED""SUCCESSFUL"

    Status of the transaction event.

    Not every value is used for every event type.

    • PENDING: The event has been created but is not final yet. Used for events that are still being processed and whose final outcome is not known yet.
    • SCHEDULED: The event is planned for a future payout cycle but has not been executed yet. This applies to payout events before money is actually sent out.
    • RECONCILED: The underlying payment has been matched with settlement data and is ready to continue through payout processing, but the funds have not been paid out yet. This applies to payout events.
    • PAID_OUT: The payout event has been completed and the funds were included in a merchant payout.
    • REFUNDED: A refund event has been accepted and recorded in the refund flow. This is the status returned for refund events once the transaction amount is being or has been returned to the payer.
    • SUCCESSFUL: The event completed successfully. Use this as the generic terminal success status for event types that do not expose a more specific business outcome such as PAID_OUT or REFUNDED.
    • FAILED: The event could not be completed. Typical examples are a payout that could not be executed or an event that was rejected during processing.

    Example: "SUCCESSFUL"

  • amountnumber
    format: float

    Amount associated with the transaction event, in major units.

    Example: 10.1

  • timestampstring
    format: date-time

    The timestamp of when the transaction event occurred.

    Example: "2020-05-25T10:49:42.784Z"

  • format: float

    Fee associated with the transaction event, in major units.

    Example: 0.25

  • Consecutive number of the installment associated with the event.

    Example: 1

  • format: float

    Amount deducted from the merchant for the event, in major units.

    Example: 10.1

  • format: float

    Fee deducted from the merchant for the event, in major units.

    Example: 0.25

Type to search…