afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/MerchantAccountEvent.json

71 lines
2.6 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"field_reference"
],
"title": "MerchantAccountEvent - Data API",
"description": "Represents a merchant account platform event. Subscribe to these events so you can listen and respond to them when theyre 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.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"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: CreateMerchant account is created. DisableThe account is deactivated. For example, the payment provider or the merchant disables an account due to fraudulent activity. PaymentEnableThe account is active and ready to receive payments. PayoutEnableThe account is ready to receive payouts. UpdateMerchant 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"
}
},
"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.",
"field_reference": {
"ChangeType": {
"field_label": "Merchant Account Event Change Type",
"type": "picklist",
"length": "255"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"EventUuid": {
"field_label": "Event UUID",
"type": "string",
"length": "36"
},
"MerchantAccountId": {
"field_label": "Merchant Account ID",
"type": "reference",
"length": "18"
},
"ReplayId": {
"field_label": "Replay Id",
"type": "string",
"length": "1000"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}