bank_status_update

When it fires

This event is triggered when a bank becomes active or inactive. An active bank means the bank is working properly and the member can connect to it. An inactive bank means the bank is not working properly; it is still displayed in the bank list but cannot be selected.

Payload fields

Field	Type	Description
event	String	The name of the webhook event.
bank	Object	The bank that triggered the event.
bank.id	String	The bank id stored in the Spaycial repository.
bank.name	String	The name of the bank.
bank.active	Boolean	Whether the bank is active.
shoppingHubExternalId	String	Programme id in your system.
shoppingHubId	String	Programme id (Spaycial).

Example

{
    "event": "bank_status_update",
    "shoppingHubExternalId": "3145",
    "shoppingHubId": "492f0b39-c205-4fb2-a225-70e042df3fdb",
    "bank": {
        "id": "398f0b39-c205-4fb2-a225-70e042df3fdb",
        "name": "Société Générale",
        "active": true
    }
}

Related

• List banks