ProcessExceptionEvent

Notifies subscribers of errors that occur during payment processing (capture, apply, and refund) on an order summary. Use this event to trigger subscribers such as flows in your order workflow. This object is available in API version 50.0 and later.

Supported Calls

create(), describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/ProcessExceptionEvent

Event Delivery Allocation Enforced

Yes

Fields

Field	Details
AttachedToId	Type reference Properties Create Description ID of the object associated with the ProcessException. This field is a polymorphic relationship field. Relationship Name AttachedTo Relationship Type Lookup Refers To CreditMemo, FulfillmentOrder, Invoice, Order, OrderItem, OrderItemSummary, OrderPaymentSummary, OrderSummary, Payment, PaymentAuthorization, Refund, ReturnOrder, WebCart, WebStore
BackgroundOperationId	Type reference Properties Create, Nillable Description The operation where the exception occurred. This field is a relationship field. Relationship Name BackgroundOperation Relationship Type Lookup Refers To BackgroundOperation
Description	Type textarea Properties Create, Nillable Description Detailed description of the ProcessException.
EventUuid	Type string Properties Nillable Description A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later.
ExceptionType	Type picklist Properties Create Description Process type that caused the exception. Possible values are: `Commerce Inventory Delete Reservation Failed` This value is reserved for future use. `Commerce Inventory Update Reservation Failed` This value is reserved for future use. `OM Apply Failed` `OM Capture Failed` `OM Refund Failed` `OM RMA Failed` This value is available in API v52.0 and later. `Place Order Failed` This value is available in API v57.0 and later.
ExternalReference	Type string Properties Create, Nillable Description Description of external entities associated with the ProcessException.
Message	Type string Properties Create Description Short description of the ProcessException
OrderSummaryId	Type reference Properties Create, Nillable Description ID of the OrderSummary associated with the ProcessException. The ProcessException component is displayed on this OrderSummary. This field is a relationship field. Relationship Name OrderSummary Relationship Type Lookup Refers To OrderSummary
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
Severity	Type picklist Properties Create, Defaulted on create, Nillable Description Severity of the ProcessException. Each severity value corresponds to one severity category. You can customize the severity picklist to represent your business processes. If you customize the severity picklist, include at least one severity value for each severity category. Severity is set to Null when creating events for payment failures. Possible values are: `High` `Low` `Null` The default value is `High`.

Platform Events Developer Guide

No Results