Below is a summary of the API endpoints you need to implement on your server and expose to receive notifications from Setu AA. These notifications are webhooks from Setu based on the events that occur during the consent and data flow.
The base_url is the server URL you share with us to receive notifications.
To get started quickly, you can setup a mock API endpoint using Beeceptor. Once configured on Bridge, Setu will send notifications to that URL. This will help you understand the notification flow before you start to implement it on your server.
Types of notifications
Consent notification—notification triggered for the events that occur in consent flow
FI notification—notification triggered for the events that occur in data flow
Note: Webhooks retries will be added in future iterations.
The Financial Information (FI) notification is used to communicate the data session status you requested for, in Create Data Session API and the FI status of users’ linked FIPs. This is indicated using two status present in the FI notification payload.
The FI notification payload contains two status
Data Session Status – returns updated status of the data session; determines whether to initiate Fetch API Data API
ACTIVE- FI data session is active
COMPLETED- All requested FIP(s) have status as READY
EXPIRED- Data session had expired and no data fetch can happen for the dataSessionId
FAILED- Data Session request failed, retry creating a new session
FIStatus - return status of the FIP(s) linked to the data session
READY - FIP is ready with requested data
DENIED - FIP has denied data sharing
PENDING - FIP received the data session request
DELIVERED - FIP has delivered the requested data
TIMEOUT - Request to FIP has timed out
Fetch FI Data API should be called only when these conditions are satified:
Data Session status is ACTIVE or COMPLETED (all FIPs are ready)
FIStatus is READY.
FI Notification Payload
Setu will notify you whenever the FIP (Financial Information Provider) responds with updated status. The following payload will be posted on your configured webhook endpoint.