Payment Messages

Messages that represent a change or an action performed on a Payment or Payment Method.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.

You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Payment Messages

Messages that represent a change or an action performed on a Payment.

Payment Created

Payment Interaction Added

Payment Transaction Added

Payment Transaction State Changed

Payment Transaction Interface ID Set

Payment Status State Transition

Payment Status Interface Code Set

Payment Interface ID Set

Payment Method Info Interface Set

Payment Method Info Method Set

Payment Method Info Name Set

Payment Method Info Token Set

Payment Method Info Interface Account Set

Payment Method Info Custom Type Set

Payment Method Info Custom Type Removed

Payment Method Info Custom Field Added

Payment Method Info Custom Field Changed

Payment Method Info Custom Field Removed

Payment Created

Generated after a successful Create Payment request.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`payment` Payment	Payment that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Interaction Added

Generated after a successful Add InterfaceInteraction update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentInteractionAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interaction` CustomFields	The interface interaction that was added to the Payment.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Transaction Added

Generated after a successful Add Transaction update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentTransactionAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`transaction` Transaction	Transaction that was added to the Payment.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Transaction State Changed

Generated after a successful Change TransactionState update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentTransactionStateChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`transactionId` String	Unique identifier for the Transaction for which the Transaction State changed.
`state` TransactionState	Transaction State after the Change Transaction State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Transaction Interface ID Set

Generated after a successful Set Transaction InterfaceId update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentTransactionInterfaceIdSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`transactionId` String	Unique identifier of the Transaction.
`newInterfaceId` String	Identifier used by the payment service that processes the Payment (for example, a PSP) after Set Transaction InterfaceId update action.
`oldInterfaceId` String	Identifier used by the payment service that processes the Payment (for example, a PSP) before the Set Transaction InterfaceId update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Status State Transition

Generated after a successful Transition State update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentStatusStateTransition"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`state` StateReference	State of the Payment after the Transition State update action.
`force` Boolean	Whether State transition validations were turned off during the Change Transaction State update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Status Interface Code Set

Generated after a successful Set StatusInterfaceCode update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentStatusInterfaceCodeSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interfaceCode` String	The `interfaceCode` that was set during the Set StatusInterfaceCode update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Interface ID Set

Generated after a successful Set InterfaceId update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentInterfaceIdSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interfaceId` String	Interface ID of the Payment after the Set InterfaceId update action.
`oldInterfaceId` String	Interface ID of the Payment before the Set InterfaceId update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Interface Set

Generated after a successful Set MethodInfo Interface update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoInterfaceSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interface` String	Payment interface of the Payment Method after the Set MethodInfo Interface update action.
`oldInterface` String	Payment interface of the Payment Method before the Set MethodInfo Interface update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Method Set

Generated after a successful Set MethodInfo Method update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoMethodSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`method` String	Payment Method after the Set MethodInfo Method update action.
`oldMethod` String	Payment Method before the Set MethodInfo Method update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Name Set

Generated after a successful Set MethodInfo Name update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	Name of the Payment Method after the Set MethodInfo Name update action.
`oldName` LocalizedString	Name of the Payment Method before the Set MethodInfo Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Token Set

Generated after a successful Set MethodInfo Token update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoTokenSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`token` PaymentMethodToken	Token of the Payment Method after the Set MethodInfo Token update action.
`oldToken` PaymentMethodToken	Token of the Payment Method before the Set MethodInfo Token update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Interface Account Set

Generated after a successful Set MethodInfo InterfaceAccount update action on Payments and Set MethodInfo InterfaceAccount update action on My Payments.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoInterfaceAccountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interfaceAccount` String	Interface account of the Payment Method after the Set MethodInfo InterfaceAccount update action.
`oldInterfaceAccount` String	Interface account of the Payment Method before the Set MethodInfo InterfaceAccount update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Custom Type Set

Generated after adding Custom Fields to a PaymentMethodInfo using the Set MethodInfo Custom Type update action on Payments and the Set MethodInfo Custom Type update action on My Payments.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoCustomTypeSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customFields` CustomFields	The Custom Fields that were set.
`oldTypeId` String	`id` of the previous Type. Absent if there was no previous Custom Type present.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Custom Type Removed

Generated after removing Custom Fields from a PaymentMethodInfo using the Set MethodInfo Custom Type update action on Payments and the Set MethodInfo Custom Type update action on My Payments.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoCustomTypeRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldTypeId` String	`id` of the Type that was removed. Absent if there was no previous Custom Type present.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Custom Field Added

Generated after adding a Custom Field to a PaymentMethodInfo using the Set MethodInfo CustomField update action on Payments and the Set MethodInfo CustomField update action on My Payments. If a Custom Field already exists with the same name, a PaymentMethodInfoCustomFieldChanged Message is generated instead.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoCustomFieldAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that was added.
`value` CustomFieldValue	The added CustomFieldValue based on the FieldType.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Custom Field Changed

Generated after changing an existing Custom Field on a PaymentMethodInfo using the Set MethodInfo CustomField update action on Payments and the Set MethodInfo CustomField update action on My Payments.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoCustomFieldChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that changed.
`value` CustomFieldValue	CustomFieldValue based on the FieldType after the Set CustomField update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Info Custom Field Removed

Generated after removing a Custom Field from a PaymentMethodInfo using the Set MethodInfo CustomField update action on Payments and the Set MethodInfo CustomField update action on My Payments.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInfoCustomFieldRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that was removed.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Messages

Messages that represent a change or an action performed on a Payment Method.

Payment Method Created

Payment Method Deleted

Payment Method Default Set

Payment Method Interface Account Set

Payment Method Payment Interface Set

Payment Method Set

Payment Method Key Set

Payment Method Name Set

Payment Method Status Set

Payment Method Custom Type Set

Payment Method Custom Type Removed

Payment Method Custom Field Added

Payment Method Custom Field Changed

Payment Method Custom Field Removed

Payment Method Created

Generated after a successful Create PaymentMethod request.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCreated"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`paymentMethod` PaymentMethod	PaymentMethod that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Deleted

Generated after a successful Delete PaymentMethod request.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodDeleted"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`paymentMethod` PaymentMethod	The PaymentMethod that was deleted.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Default Set

Generated after a successful Set Default update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodDefaultSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`default` Boolean	Default Payment Method after the Set Default update action.
`oldDefault` Boolean	Default Payment Method before the Set Default update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Interface Account Set

Generated after a successful Set InterfaceAccount update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodInterfaceAccountSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`interfaceAccount` String	Interface account of the Payment Method after the Set InterfaceAccount update action.
`oldInterfaceAccount` String	Interface account of the Payment Method before the Set InterfaceAccount update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Payment Interface Set

Generated after a successful Set PaymentInterface update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodPaymentInterfaceSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`paymentInterface` String	Payment interface of the Payment Method after the Set PaymentInterface update action.
`oldPaymentInterface` String	Payment interface of the Payment Method before the Set PaymentInterface update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Set

Generated after a successful Set Method update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodMethodSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`method` String	Payment Method after the Set Method update action.
`oldMethod` String	Payment Method before the Set Method update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Key Set

Generated after a successful Set Key update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`key` String	`key` value of the PaymentMethod after the Set Key update action.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodKeySet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldKey` String	`key` value of the PaymentMethod before the Set Key update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Name Set

Generated after a successful Set Name update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodNameSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	Name of the Payment Method after the Set Name update action.
`oldName` LocalizedString	Name of the Payment Method before the Set Name update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Status Set

Generated after a successful Set PaymentMethodStatus update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodPaymentMethodStatusSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`status` PaymentMethodStatus	Status of the Payment Method after the Set PaymentMethodStatus update action.
`oldStatus` PaymentMethodStatus	Status of the Payment Method before the Set PaymentMethodStatus update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Custom Type Set

Generated after adding a Custom Type to a Payment Method using the Set Custom Type update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCustomTypeSet"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`customFields` CustomFields	The Custom Fields that were set.
`oldTypeId` String	`id` of the previous Custom Type. Absent if there was no previous Custom Type present.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Custom Type Removed

Generated after removing a Custom Type from a Payment Method using the Set Custom Type update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCustomTypeRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`oldTypeId` String	`id` of the Custom Type that was removed. Absent if there was no previous Custom Type present.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Custom Field Added

Generated after adding a Custom Field to a Payment Method using the Set CustomField update action. If a Custom Field already exists with the same name, a PaymentMethodCustomFieldChanged Message is generated instead.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCustomFieldAdded"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that was added.
`value` CustomFieldValue	The added CustomFieldValue based on the FieldType.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Custom Field Changed

Generated after changing an existing Custom Field on a Payment Method using the Set CustomField update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCustomFieldChanged"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that changed.
`value` CustomFieldValue	CustomFieldValue based on the FieldType after the Set CustomField update action.
`oldValue` CustomFieldValue	CustomFieldValue based on the FieldType before the Set CustomField update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Method Custom Field Removed

Generated after removing a Custom Field from a Payment Method using the Set CustomField update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int64	Version of a resource. In case of Messages, this is always `1`.
`sequenceNumber` Int64	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1. `sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
`resource` Reference	Reference to the resource on which the change or action was performed.
`resourceVersion` Int64	Version of the resource on which the change or action was performed.
`type` String	`"PaymentMethodCustomFieldRemoved"` Message Type of the Message.
`resourceUserProvidedIdentifiers` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` String	Name of the Custom Field that was removed.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Payment Messages