The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.
API reference
/
Models
NotificationEventTypeDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Output DTO for a notification event type definition.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description eventType
required string
Canonical event type string.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
displayName
required string
Human-readable display name.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
description
required string
Description of when this event is published.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maxScope
required SubscriptionScope
SubscriptionScope The broadest scope that can subscribe to this event.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
MerchantSubscription scoped to a specific merchant. Only matches events originating from that merchant. ResellerSubscription scoped to a reseller and all its descendants (sub-resellers and merchants). Uses ResellerPathPrefix for efficient hierarchy matching. AdminSubscription with tenant-wide scope. Matches events across all resellers and merchants within the tenant. Requires admin-level permissions.
category
required string
Category for grouping (e.g., "Transactions").
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
filterFields
required array of FilterFieldDefinitionDto
array of FilterFieldDefinitionDto Fields available for filter conditions.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each FilterFieldDefinitionDto:
Field
Type
Description field
required string
Dot-delimited attribute path.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
displayName
required string
Human-readable label.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
type
required FilterFieldType
FilterFieldType Data type.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
StringFree-text string field. Supports Eq, Ne, Contains, StartsWith, In. NumberNumeric field (decimal). Supports Eq, Ne, Gt, Gte, Lt, Lte, In. BooleanBoolean field. Supports Eq, Ne only. DateTimeDate/time field (UTC). Supports Eq, Ne, Gt, Gte, Lt, Lte. EnumEnumerated value field with a fixed set of allowed values. Supports Eq, Ne, In.
allowedValues
required array of string
array of Allowed values for enum fields.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowedOperators
required array of NotificationsFilterOperator
array of NotificationsFilterOperator Operators valid for this field.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
EqExact equality comparison. NeNot equal comparison. GtGreater than (numeric/datetime fields only). GteGreater than or equal (numeric/datetime fields only). LtLess than (numeric/datetime fields only). LteLess than or equal (numeric/datetime fields only). ContainsSubstring containment (string fields only). StartsWithPrefix match (string fields only). InValue is one of a set (any field type).
This body has no documented fields.
This model has no documented fields.
Next steps