Accounts

Reference information for our Accounts webhook events.

Historical update

As soon as your banking recurrent link is created, we asynchronously load the accounts available. You will receive a historical_update notification whenever the accounts list is available for you to access.

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "ACCOUNTS",
  "webhook_code": "historical_update",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "data": {
    "total_accounts": 5 // Total number of accounts found.
  }
}

Once you receive the notification, you can get details on the accounts by making the following request:

curl --request GET 'https://api.belvo.com/api/accounts/?link={id}' \
  -u [Secret Key ID]:[Secret Key PASSWORD]
client.accounts.list({
  filters: {
    link: "{id}"
  }
})
client.Accounts.list(link="{id}")
client.accounts.list(params: {
  link: "{id}"
})

Where:

  • {id} is the link_id your receive in the webhook notification.

New accounts available

You can receive a new_accounts_available notification whenever new accounts are available for a bank recurrent link.

Once you receive the notification, you can query the Accounts endpoint to pull the details of these new accounts. For example, if you receive the following webhook:

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "ACCOUNTS",
  "webhook_code": "new_accounts_available",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "data": {
    "new_accounts": 1 // New accounts found for the link
  }
}

You can request more information about the accounts with the following query to the Accounts endpoint:

curl --request GET 'https://api.belvo.com/api/accounts/?link={id}' \
  -u [Secret Key ID]:[Secret Key PASSWORD]
client.accounts.list({
  filters: {
    link: "{id}"
  }
})
client.Accounts.list(link="{id}")
client.accounts.list(params: {
  link: "{id}"
})

Where:

  • {id} is the link_id you receive in the notification.

Did this page help you?