History And Events
History And Events API enables publishing alert events and retrieving alert history. This is the bridge between events occurring in the system and alerts being sent to customers.
End-user benefits
- Receive proactive notifications about account activity
- Stay informed about important financial events in real-time
Integration capabilities
- Publish account, transaction, and notification events
- Retrieve alert history with filtering by account, date, and status
- Track alert delivery across Email, SMS, and Push channels
- Business Banking: use
institutionCustomerIdfor location/business context; resolve the business entity via the Institution User API when needed.
Event domain types
| Event type | Description |
|---|---|
| AccountEvent | Account-related (e.g. balance changes, status updates) |
| TransactionEvent | Transaction-related (deposits, withdrawals, transfers) |
| NotificationEvent | General / external notification passthrough |
Alert history
Retrieve published alerts using various filter parameters:
- Filter by account IDs
- Filter by date range (startDate, endDate)
- Filter by alert type names
- Filter by delivery status (EMAIL, SMS, PUSH)
- Filter by read/unread status
Scopes
Alert history
| Scope | Description |
|---|---|
alertHist:read | Read alert history |
Realtime publish
| Scope | Description |
|---|---|
alerts:publish | Publish alert events |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer OAuth 2.0 access token |
transactionId | UUID for request tracing |
Error codes
Alert history
| Code | Message | HTTP Status Code |
|---|---|---|
| PRMSYS_10003 | Unknown application error occurred | 400 |
| PRMSYS_10004 | Error occurred while validating JWT token | 400 |
| PRMSYS_10009 | Resource doesn't exist for the provided search criteria | 500 |
| PRMSYS_10011 | Unauthorized access to the resource | 404 |
| PRMSYS_10012 | Unauthorized access — JWT value mismatch | 404 |
| PRMVAL_10014 | Invalid date format | 400 |
Realtime publish
| Code | Message | HTTP Status Code |
|---|---|---|
| PRMSYS_10002 | Malformed input data | 500 |
| PRMSYS_10003 | Missing eventDetails or notification | 500 |
| PRMSYS_10007 | Missing mandatory fields | 500 |
| PRMSYS_10008 | Invalid institutionId | 500 |
| PRMSYS_10013 | Missing Authorization Token | 500 |
Endpoints
Get Alert History
Retrieve specific alert history records using content ID, history summary ID, or event ID.
List Alert History
Retrieve alert history data using various filter parameters. You can filter by account IDs, date range,
Publish Alert Event
Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.