Institution Alerts allow financial institutions to enable, disable, or tailor alert types
for their specific environment. They capture institution‑level opt‑in status, supported
channels, and configuration overrides, enabling institutions to control which alerts are
available to their customers.
End-user benefits
- Financial institutions can customize alert types and delivery channels to align with their
brand and customer preferences.
- Enables targeted notifications for specific account types and transaction scenarios.
- Supports multi-channel delivery (Email, SMS, Push, Web) to meet customer communication
preferences.
Integration capabilities
- List institution alert types with filters (alertTypeName, externalSystem, status
active/inactive).
- Create and maintain financial institution scoped alert type rows aligned to institution
programs.
- Provides centralized alert management by defining available alert types, configuring dynamic
message templates, supporting multi‑channel delivery (Email, SMS, Push, Web), and enabling
institution‑specific channel controls and customizations.
Scopes
| Scope | Description |
|---|
alertMgmt:read | Read alert types and associated templates |
alertMgmt:write | Write alert types and associated templates |
| 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