Skip to main content

Documentation Index

Fetch the complete documentation index at: https://telr-docs.cashfree.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks are event-based notifications that are received when a specific event related to the account aggregator occurs.

​
Add Webhooks

Add your webhook URL in our system for us to deliver webhook events. Follow the instructions below to configure the webhook URL. Ensure to provide the publicly accessible HTTPS URL to your webhook endpoint.
  1. Once you login to the dashboard with the credentials, click Developers.
  2. Click Webhooks listed under the Verification Suite card.
  3. Click Add Webhook URL in the Developers - Verification Suite screen.
  4. In the Add Webhook popup, fill in the following information:
  • Webhook URL - Enter the URL in this field.
  1. Click Test & Add Webhook.
EventDescription
AA_CONSENT_VERIFICATION_SUCCESSConsent is approved.
AA_CONSENT_VERIFICATION_PAUSEDConsent is paused.
AA_CONSENT_VERIFICATION_REVOKEDConsent is revoked.
AA_CONSENT_VERIFICATION_REJECTEDConsent is rejected.
AA_CONSENT_VERIFICATION_EXPIREDConsent has expired.
{
    "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
    "event_type": "AA_CONSENT_VERIFICATION_SUCCESS",
    "event_time": "2024-02-15 16:53:15",
    "version": "1.0",
    "data": {
    "status": "SUCCESS",
    "consent_verification_id": "a12bc34def56789"
    }
}

​
FI Webhook Event

EventDescription
AA_FI_VERIFICATION_SUCCESSFinancial information verification is successful.
AA_FI_VERIFICATION_ACTIVEFinancial information consent is active.
AA_FI_VERIFICATION_FAILEDFinancial information verification has failed.
AA_FI_VERIFICATION_EXPIREDFinancial information verification has expired.
{
    "signature": "e8f06e55abcf7483f3249b7a992f4a2d",
    "event_type": "AA_FI_VERIFICATION_ACTIVE",
    "event_time": "2024-02-15 16:53:15",
    "version": "1.0",
    "data": {
    "status": "ACTIVE",
    "fi_verification_id": "v1234567890abcdef",
    "fi_status_response": [
            {
                "fip_id": "FIP_1",
                "accounts": [
                    {
                        "link_ref_number": "b2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                        "fi_status": "READY"
                    },
                    {
                        "link_ref_number": "a2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                        "fi_status": "TIMEOUT"
                    }
                ]
            },
            {
                "fip_id": "FIP_2",
                "accounts": [
                    {
                        "link_ref_number": "c2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b",
                        "fi_status": "READY"
                    }
                ]
            }
        ]
    }
}
Note: Verifying the signature is mandatory before processing any response. Refer to Signature Verification for more details.