---
schema_version: "1"
id: 13343cc768a1ae414276d0fceb2e48884260b105fab38cd200991a6213ca05b9
title: PaymentIntentEvent
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_paymentintentevent.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentintentevent.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: fdb5a2a35dfbf66c0c0c9303b91df41e7577a6d2d0dcc6dc118766cacf4a9556
description: Represents a payment intent platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later.
---
# PaymentIntentEvent

Represents a payment intent platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later.

For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)").

## Supported Calls

describeSObjects()

## Special Access Rules

To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience.

## Fields

| Field | Details |
| --- | --- |
| ChangeType | 
Type

picklist

Properties

Restricted picklist

Description

Type of payment intent event that triggers an event notification. You can write code to operate conditionally on the value of this field. For example, you can ignore an authorization but get notified of captures.

Possible values are:

- Authorize–Payment is authorized.
- AuthorizeFailure–There’s an error preventing the payment authorization
- Capture–Payment is captured.
- CaptureFailure– An error prevented the payment capture.
- Refund–Payment is refunded.
- RefundFailure–An error prevented the payment refund.





 |
| PaymentInitiationSourceApplication | 

Type

picklist

Properties

Nillable, Restricted picklist

Description

Salesforce application initiating the payment. This field is available in API version 63.0 and later.

Possible values are:

- Collections
- Commerce
- Custom
- FieldService
- OrderManagement
- Payments
- Revenue
- Sales
- Scheduler
- Service





 |
| PaymentInitiationSourceChannel | 

Type

string

Properties

Nillable

Description

Identifies the channel in the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later.



 |
| PaymentInitiationSource | 

Type

reference

Properties

Nillable

Description

Identifies the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later.

This field is a relationship field.

Relationship Name

PaymentInitiationSource

Refers To

PaymentInitiationSource



 |
| PaymentInitiationSourceProcess | 

Type

string

Properties

Nillable

Description

Identifies the process in the Payment Initiation Source record for which the event occurs.



 |
| PaymentIntentGuid | 

Type

string

Properties

Nillable

Description

Identifies the GUID in the Payment Initiation Source record for which the event occurs. This field is available in API version 63.0 and later.



 |
| PaymentIntent | 

Type

reference

Properties

Nillable

Description

Identifies the PaymentIntent record for which the event occurs. This field is available in API version 63.0 and later.

This field is a relationship field.

Relationship Name

PaymentIntent

Relationship Type

Lookup

Refers To

PaymentIntent



 |
| PaymentLink | 

Type

reference

Properties

Nillable

Description

Identifies the payment link record for which the event occurs. This field is available in API version 63.0 and later.

This field is a relationship field.

Relationship Name

PaymentLink

Refers To

PaymentLink



 |