Notification Channels
Notification Channels API manages customer event subscriptions. This enables customers to receive alerts through their preferred communication channels.
Note: These endpoints require a V1 OAuth token. See Authentication API documentation for V1 token endpoint details.
End-user benefits
- Subscribe to specific event types
- Control how and where they receive notifications
Integration capabilities
- Create and manage event subscriptions per user or institution
- Send events to subscribed end-users
Error codes
| HTTP Status Code | Message |
|---|---|
| 400 | Missing Required HTTP Headers or Invalid/Missing Inputs |
| 401 | Authorization invalid or Missing Authorization Header |
| 404 | Entities not Found (User or Account not found) |
| 500 | Internal Server Error |
Endpoints
Create Subscription
Creates a new Subscription.
Delete Subscription
Delete a Subscription
Get Subscription by ID
Retrieves the Subscription identified by the subscription_id
List Institution Subscriptions
Retrieves the first twenty subscriptions.
List User Subscriptions
Retrieve the subscriptions for a given fi and customer. This can be filtered by a single eventType or
Send Event
Sends the necessary event to the message service.
Update Subscription
Updates an existing Subscription