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.
describeSObjects()
| Subscriber | Supported? |
|---|---|
| Apex Triggers |  |
| Flows | |
| Processes | |
| Pub/Sub API | |
| Streaming API (CometD) | |
/event/PaymentCreationEvent
No
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.
Type: string
Properties: Nillable
Description: Reserved for future use.
Type: string
Properties: Nillable
Description: Error code sent from the payment gateway after a request encountered an error.
Type: textarea
Properties: Nillable
Description: Message sent from the payment gateway after a request encountered an error.
Type: string
Properties: Nillable
Description: A universally unique identifier (UUID) that identifies a platform event message.
Type: boolean
Properties: Defaulted on create
Description: Indicates whether the request was successful. The default value is ‘false’.
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
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
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, or Processed.
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.
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: picklist
Properties: Nillable, Restricted picklist
Description: Indicates whether the payment was made for a payment capture request or payment sale request. Possible values are: Values are Capture or Sale.