Consent notification

This notification is used to communicate the updated status of the consent.

Types of consent status

  • ACTIVE - Customer has approved consent

  • REJECTED - Customer has rejected consent

  • REVOKED - Customer revoked consent for an existing approved consent

  • PAUSED - Customer paused consent for an existing approved consent

  • EXPIRED - Consent request has expired

We do not send notification for consent status PENDING, this is when consent is just created.

Consent Notification Payload

Setu will post this payload to your notification endpoint whenever there is a change in consent status.

{
    "type": "CONSENT_STATUS_UPDATE",
    "timestamp": "2018-12-06T11:39:57.153Z",
    "consentId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
    "success": true,
    "data": {
        "status": "ACTIVE",
        "Detail": {
        // consent details object
        } 
    },
    "error": "error"
}

Error notification

In the following two scenarios, an error notification will be sent:

  • No FIP Accounts Discovered

  • Consent creation failure on the AA

Error notification payload:

{
    "type": "CONSENT_STATUS_UPDATE",
    "timestamp": "2018-12-06T11:39:57.153Z",
    "consentId": "d4f40bd9-a22f-4408-a622-4e8a1e4fbda6",
    "success": true,
    "data": null,
    "error": {
        "code": "NoFIPAccountsDiscovered",
        "message": "no_fip_accounts_found"
    }
}