UbersichtEvent

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

Payload

string

required

Discriminator field that determines the event payload structure.Allowed values: ActionRequired, PaymentCreated, PaymentStatusChanged, ProcessingStatusChanged, TransactionStatusChanged

object

required

Serialized snapshot of the payment at the time of the event.

Show properties

string

UUID of the payment.

string

UUID of the account.

number

Payment amount.

string

ISO 4217 currency code.

string

Payment status.

string

Processing status. See API reference for allowed values.

object

Current processing requirement, if any. See API reference for structure.

string

UUID of the customer.

string

Merchant-assigned order identifier.

object

Payment instrument details. See API reference for structure.

object

Payment method details. See API reference for structure.

string

UUID of the processor merchant.

string

Name of the processor merchant.

number

Amount authorized by the processor.

number

Amount captured by the processor.

number

Amount refunded by the processor.

array

Distribution instructions. See API reference for structure.

array

Associated refunds. See API reference for structure.

array

Associated transactions. See API reference for structure.

object

Additional metadata. See API reference for structure.

object

Custom metadata. See API reference for structure.

number

Current payment balance.

string

Creation timestamp. Format: ISO 8601 date-time.

string

Last update timestamp. Format: ISO 8601 date-time.

string

UUID of the affected transaction. Only present when type is TransactionStatusChanged.

Inbound

Outbound

Payload

​Payload

Payload