> ## Documentation Index
> Fetch the complete documentation index at: https://developer.hellgate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# UbersichtEvent

> Notifies subscribers of payment and transaction state changes.

Sent by Commerce to notify subscribers of payment lifecycle events. The payload structure varies based on the `type` field.

`ce-type: UbersichtEvent`

## Payload

<ParamField body="type" type="string" required>
  Discriminator field that determines the event payload structure.

  Allowed values: `ActionRequired`, `PaymentCreated`, `PaymentStatusChanged`, `ProcessingStatusChanged`, `TransactionStatusChanged`
</ParamField>

<ParamField body="payment" type="object" required>
  Serialized snapshot of the payment at the time of the event.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the payment.
    </ParamField>

    <ParamField body="account_id" type="string">
      UUID of the account.
    </ParamField>

    <ParamField body="amount" type="number">
      Payment amount.
    </ParamField>

    <ParamField body="currency_code" type="string">
      ISO 4217 currency code.
    </ParamField>

    <ParamField body="status" type="string">
      Payment status.
    </ParamField>

    <ParamField body="processing_status" type="string">
      Processing status. See API reference for allowed values.
    </ParamField>

    <ParamField body="processing_requirement" type="object">
      Current processing requirement, if any. See API reference for structure.
    </ParamField>

    <ParamField body="customer_id" type="string">
      UUID of the customer.
    </ParamField>

    <ParamField body="order_id" type="string">
      Merchant-assigned order identifier.
    </ParamField>

    <ParamField body="payment_instrument" type="object">
      Payment instrument details. See API reference for structure.
    </ParamField>

    <ParamField body="payment_method" type="object">
      Payment method details. See API reference for structure.
    </ParamField>

    <ParamField body="processor_merchant_id" type="string">
      UUID of the processor merchant.
    </ParamField>

    <ParamField body="processor_merchant_name" type="string">
      Name of the processor merchant.
    </ParamField>

    <ParamField body="processor_amount_authorized" type="number">
      Amount authorized by the processor.
    </ParamField>

    <ParamField body="processor_amount_captured" type="number">
      Amount captured by the processor.
    </ParamField>

    <ParamField body="processor_amount_refunded" type="number">
      Amount refunded by the processor.
    </ParamField>

    <ParamField body="distributions" type="array">
      Distribution instructions. See API reference for structure.
    </ParamField>

    <ParamField body="refunds" type="array">
      Associated refunds. See API reference for structure.
    </ParamField>

    <ParamField body="transactions" type="array">
      Associated transactions. See API reference for structure.
    </ParamField>

    <ParamField body="additional_information" type="object">
      Additional metadata. See API reference for structure.
    </ParamField>

    <ParamField body="metadata" type="object">
      Custom metadata. See API reference for structure.
    </ParamField>

    <ParamField body="balance" type="number">
      Current payment balance.
    </ParamField>

    <ParamField body="created_at" type="string">
      Creation timestamp. Format: ISO 8601 date-time.
    </ParamField>

    <ParamField body="updated_at" type="string">
      Last update timestamp. Format: ISO 8601 date-time.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="transaction_id" type="string">
  UUID of the affected transaction. Only present when `type` is `TransactionStatusChanged`.
</ParamField>