System Alerts

System Alerts define the core alert events available in the platform, including definitions that may align with external systems or third-party vendors (for example, partner platforms, notification providers, or core integrations). They describe what triggers an alert, its category and event domain, applicable account types, and supported delivery channels.

End-user benefits

• Defines what events customers can be notified about, delivering a standardized and predictable alert experience.
• Alerts are tied to specific account and transaction events, helping customers stay informed about meaningful activity.
• Supports notifications across common channels to meet customer communication preferences.

Integration capabilities

• Define available alert types and their metadata.
• Associate notification channels (Email, SMS, Push, Web) with types where the model allows.
• Filter list operations by alert category, alert type name, or external system.

Supported channels

Channel	Description
EMAIL	Email notifications
SMS	Text messages
PUSH	Mobile push
WEB	Web notifications

Scopes

Scope	Description
alertMgmt:read	Read alert types and associated templates
alertMgmt:write	Write alert types and associated templates

Required headers

Header	Description
Authorization	Bearer OAuth 2.0 access token
transactionId	Unique request identifier

Error codes

System (PRMSYS_*)

Code	Message	HTTP Status Code
PRMSYS_10001	Cross talk / concurrency error occurred	400
PRMSYS_10002	Malformed input data	400
PRMSYS_10003	Unknown application error occurred	400
PRMSYS_10004	Error occurred while validating JWT token	400
PRMSYS_10005	Resource of name already exists	204
PRMSYS_10006	Requested resource of identifier doesn't exist	400
PRMSYS_10007	Resource of identifier already exists	400
PRMSYS_10008	Requested resource of name doesn't exist	400
PRMSYS_10015	Required attribute missing	400
PRMSYS_10016	Non Printable ASCII character detected	400

Validation (PRMVAL_*)

Code	Message	HTTP Status Code
PRMVAL_10001	Path parameter doesn't match request body value	400
PRMVAL_10002	Invalid value for field	400
PRMVAL_10003	Invalid institution	400
PRMVAL_10005	Invalid channel type	400
PRMVAL_10006	Invalid alert type	400
PRMVAL_10007	Field is required	400
PRMVAL_10008	Field is invalid	400

Endpoints

Create Alert Type

Create a new alert type for your financial institution. When you create an alert type, you define: - A

Delete Alert Type

Delete an alert type that is no longer needed. This permanently removes the alert type from the database.

List Alert Types

Retrieve a list of all alert types configured for the financial institution. The response includes all

Update Alert Type

Update an existing alert type. You can modify any of the alert type settings, including the name, status,