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.

MerchantAccountEvent

Represents a merchant account 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.

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 merchant account event, which triggers an event notification. You can write code to listen to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates. Possible values are: `Create`–Merchant account is created. `Disable`–The account is deactivated. For example, the payment provider or the merchant disables an account due to fraudulent activity. `PaymentEnable`–The account is active and ready to receive payments. `PayoutEnable`–The account is ready to receive payouts. `Update`–Merchant account property change occurs.
MerchantAccountId	Type reference Properties Nillable Description Identifies the merchant account for which the event occurs. This field is a relationship field. Relationship Name MerchantAccount Relationship Type Lookup Refers To MerchantAccount

Field

Details

ChangeType

Type

picklist

Properties

Restricted picklist

Description

Type of merchant account event, which triggers an event notification. You can write code to listen to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates.

Possible values are:

Create–Merchant account is created.
Disable–The account is deactivated. For example, the payment provider or the merchant disables an account due to fraudulent activity.
PaymentEnable–The account is active and ready to receive payments.
PayoutEnable–The account is ready to receive payouts.
Update–Merchant account property change occurs.

MerchantAccountId

Type: reference
Properties: Nillable
Description: Identifies the merchant account for which the event occurs.; This field is a relationship field.
Relationship Name: MerchantAccount
Relationship Type: Lookup
Refers To: MerchantAccount

Object Reference for the Salesforce Platform

MerchantAccountEvent

Supported Calls

Special Access Rules

Fields