Linked Accounts

Subscribe to webhook events for linked account status changes.

The following webhook events are available for your Accounts integration.

Event	Description
linked_account.requires_action	Linked Account requires further action to proceed.
linked_account.processing	Linked Account is in the process of being set up.
linked_account.succeeded	Linked Account verification is successful and is active.
linked_account.failed	Linked Account failed verification or is inactive.
linked_account.suspended	Linked Account is suspended.

Payload examples

Relevant webhook events:

linked_account.requires_action
linked_account.processing
linked_account.succeeded
linked_account.failed
linked_account.suspended

Payload example:

JSON

1{
2    "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",
3    "data":Object{...},
4    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
5    "name":"linked_account.requires_action"
6}

data

JSON

1{
2  "au_bank": {
3    "account_name": "Tester Smith",
4    "account_number": "89098199202",
5    "bsb": "063001",
6    "currency": "AUD",
7    "entity_type": "BUSINESS"
8  },
9  "capabilities": {
10    "balance_check": true,
11    "direct_debit_deposit": false
12  },
13  "id": "114907b3-a708-483e-b97a-be3742905f6f",
14  "next_action": {
15    "type": "verify_micro_deposits"
16  },
17  "status": "REQUIRES_ACTION",
18  "supported_currencies": [
19    "AUD"
20  ],
21  "type": "AU_BANK"
22}

Was this page helpful?