FI notification

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.

Data Session Status – returns updated status of the data session; determines whether to initiate Fetch API Data API

• PENDING - 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

• PARTIAL - Some FIPs are ready with the data while a few others have failed. Ready data can still be fetched. READ MORE ↗

• FAILED - Data Session request failed, retry creating a new session

FIStatus - returns 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

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.

{
    "type": "SESSION_STATUS_UPDATE",
    "timestamp": "2018-12-06T11:39:57.153Z",
    "consentId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
    "dataSessionId": "378ec65c-f558-49fc-89ea-e880c2cf88b3",
    "success": true,
    "data": {
        "status": "PENDING",
        "format": "json", // json or xml
        "DataRange": {
            "from": "2018-12-06T11:39:57.153Z",
            "to": "2021-12-31T14:25:33.440Z"
        },
        "fips": [
            {
                "fipID": "FIP-1",
                "Accounts": [
                    {
                        "linkRefNumber": "XXXX-XXXX-XXXX",
                        "FIStatus": "READY",
                        "description": ""
                    }
                ]
            }
        ],
        "error": { "code": "", "message": "" }
    }
}