Account External Linked

Event

account.external.linked

Explanation

FinTechs can utilize the Account External Linked webhook to receive notifications when an external account (such as a bank account or third-party service) is successfully linked to a customer’s account, facilitating seamless integration and enhanced customer experience.

When it occurs

This Webhook fires when an external account is linked.

Payload

{
    "event": "account.external.linked",
    "referenceId": "889a07a7-1c48-432f-a80f-6690c6e8cbd5",
    "timestamp": "2023-03-15T21:03:10.227",
    "data": {
        "requestId": "string",
        "requestDate": "string",
        "state": "COMPLETED",
        "verifiedAccount": [
            {
                "accountNumber": "string",
                "verificationStatus": "SUCCESS",
                "accountName": "string",
                "accountType": "string",
                "rtn": "string",
                "unmaskedAccountNumber": "string",
                "availableBalance": 0,
                "currentBalance": 0,
                "currencyCode": "str",
                "providerAccountId": "string",
                "providerName": "string",
                "holders": [
                    {
                        "customerId": "string",
                        "customerName": {
                            "first": "string",
                            "middle": "string",
                            "last": "string",
                            "suffix": "string",
                            "company": "string"
                        },
                        "relationship": "AUTHORIZED_USER"
                    }
                ],
                "failedReason": "string"
            }
        ]
    }
}