Event Code 117 - Open Banking Registration

The 117 event code is used when a customer interacts with an Open Banking registration session.

{
  "productId": 12345,
  "events": [117],
  "webhookStatus": "active",  
  "config": {
    "url": "https://client_domain.com/webhook",
    "customHeaders": {
      "header1": "value_1",
      "header2": "value_2"
    }
  }
}

After the webhook has been successfully set up, when a customer interacts with the application, a notification response is sent asynchronously from the Event Delivery Service to the URL specified in the webhook. The payload reflects what the customer is doing when they register, and can be one of the following event types:

started is sent when the Data Connect application is loaded and the landing web page is displayed.
institutionSupported is sent when a user selects a financial institution from a search query that is certified for the product.
discovered is sent after the customer has successfully signed in to an institution.
adding is sent when a customer enters their sign-in information at a financial institution and selects which accounts Data Connect can access to verify their financial information.
added is sent after the customer loads an eligible accounts page, and selects the account(s) they want to give access to. The accounts are saved in the resource for the account associated with the customer.
done is sent after the customer completes all necessary data connection requirements for the experience and the session ends. This event type follows the added event type.
institutionNotFound is sent when the user searches for an institution that is not recognised by Mastercard.
institutionNotSupported is sent when the user selects an institution that isn’t certified.
unableToConnect is sent when a financial institution is unavailable (unknown reasons) and a connection isn’t possible.
invalidCredentials is sent when the user enters incorrect sign-in information for the selected institution when using a legacy connection.

See the below examples of the different responses.

{
    "context": {
        "programManagerId": 12345,
        "eventCode": 117,
        "eventVersion": "v1",
        "notificationTime": "2026-02-10T10:30:42.149118Z"
    },
    "payload": {
        "event_type": "adding",
        "event_id": "1660148602272-c7cb9456479bdce2befc3424",
        "payload": {
            "institutionId": "101732",
            "oauth": "true"
        },
        "webhook_data": {
            "threddSessionId": "34fe98c9-da7a-47c6-893c-b77e7f070f20"
        },
        "event_trigger": null,
        "openbanking_customer_id": "b1b915a3-800c-42bf-87b6-64d7ff3b63f2"
    },
    "messageHeaders": {
        "schemaId": 1
    }
}

{
    "context": {
        "programManagerId": 12345,
        "eventCode": 117,
        "eventVersion": "v1",
        "notificationTime": "2026-02-10T10:27:14.094918Z"
    },
    "payload": {
        "event_type": "institutionNotSupported",
        "event_id": "1660148602272-c7cb9456479bdce2befc3424",
        "payload": {
            "institutionId": "101732"
        },
        "webhook_data": {
            "threddSessionId": "603afe05-1a92-4657-b5c7-03cf36d9dfe6"
        },
        "event_trigger": null,
        "openbanking_customer_id": "b1b915a3-800c-42bf-87b6-64d7ff3b63f2"
    },
    "messageHeaders": {
        "schemaId": 1
    }
}

{
    "context": {
        "programManagerId": 12345,
        "eventCode": 117,
        "eventVersion": "v1",
        "notificationTime": "2026-02-09T13:52:44.821671Z"
    },
    "payload": {
        "event_type": "discovered",
        "event_id": "1770645163017-e4a16a9a3b1a8697b9959fac",
        "payload": {
            "accounts": [
                {
                    "id": 9011352680,
                    "number": "xxxxxx8888",
                    "name": "Auto Loan",
                    "balance": -209.52,
                    "type": "loan",
                    "status": "pending",
                    "institutionLoginId": 9005851697
                },
                {
                    "id": 9011352687,
                    "number": "xxxxxx1111",
                    "name": "Checking",
                    "balance": 209.52,
                    "type": "checking",
                    "status": "active",
                    "institutionLoginId": 9005851697
                }
            ],
            "mfa": null,
            "institutionId": "101732",
            "oauth": false
        },
        "webhook_data": {
            "threddSessionId": "34fe98c9-da7a-47c6-893c-b77e7f070f20"
        },
        "event_trigger": null,
        "openbanking_customer_id": "4c04d862-d3cb-4a4d-a9b8-0af31a8bd9d8"
    },
    "messageHeaders": {
        "schemaId": 1
    }
}

{
    "context": {
        "programManagerId": 12345,
        "eventCode": 117,
        "eventVersion": "v1",
        "notificationTime": "2026-02-09T13:52:49.363973Z"
    },
    "payload": {
        "event_type": "added",
        "event_id": "1770645167089-ef46b3bebce351d0c9c6f176",
        "payload": {
            "accounts": [
                {
                    "id": "9011352680",
                    "number": "xxxxxx8888",
                    "accountNumberDisplay": "8888",
                    "name": "Auto Loan",
                    "balance": -209.52,
                    "type": "loan",
                    "status": "active",
                    "institutionId": "101732",
                    "balanceDate": 1770645163,
                    "aggregationAttemptDate": 1770645163,
                    "createdDate": 1770110113,
                    "lastUpdatedDate": 1770645167,
                    "linkedAccountDate": 1770645167,
                    "currency": "USD",
                    "institutionLoginId": 9005851697,
                    "displayPosition": 1,
                    "financialinstitutionAccountStatus": "OPEN",
                    "accountNickname": "Auto Loan",
                    "marketSegment": "personal"
                }
            ],
            "institutionId": "101732",
            "oauth": false
        },
        "webhook_data": {
            "threddSessionId": "34fe98c9-da7a-47c6-893c-b77e7f070f20"
        },
        "event_trigger": null,
        "openbanking_customer_id": "4c04d862-d3cb-4a4d-a9b8-0af31a8bd9d8"
    },
    "messageHeaders": {
        "schemaId": 1
    }
}

Updated 4 days ago