Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PaymentCreationEvent

Notifies subscribers when the process started by the /actions/standard/paymentSale request is complete. This object is available in API version 55.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

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

Subscription Channel

/event/PaymentCreationEvent

Event Delivery Allocation Enforced

No

Special Access Rules

To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated. Commerce Payments entities are available only in Lightning Experience.

Fields

Field	Details
CorrelationIdentifier	Type string Properties Nillable Description Reserved for future use.
ErrorCode	Type string Properties Nillable Description Error code sent from the payment gateway after a request encountered an error.
ErrorMessage	Type textarea Properties Nillable Description Message sent from the payment gateway after a request encountered an error.
EventUuid	Type string Properties Nillable Description A universally unique identifier (UUID) that identifies a platform event message.
IsSuccess	Type boolean Properties Defaulted on create Description Indicates whether the request was successful. The default value is 'false'.
PaymentGatewayLogId	Type reference Properties Nillable Description The payment gateway log containing information about the communication with the payment gateway. This is a relationship field. Relationship Name PaymentGatewayLog Relationship Type Lookup Refers To PaymentGatewayLog
PaymentId	Type reference Properties Nillable Description The payment created as the result of a successful request. This is a relationship field. Relationship Name Payment Relationship Type Lookup Refers To Payment
PaymentStatus	Type picklist Properties Nillable, Restricted picklist Description The status of the payment created after a successful request. This field reflects the status upon payment creation, and isn’t updated after further changes to the payment’s status. Possible values are: Canceled Draft Failed Pending Processed
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.
RequestIdentifier	Type string Properties Nillable Description The unique ID returned in the /actions/standard/paymentSale response. Use this ID to identify the event for a specific request.
Type	Type picklist Properties Nillable, Restricted picklist Description Indicates whether the payment was made for a payment capture request or payment sale request. Possible values are: Capture Sale