Investments (Webhooks)
Reference information for our Investment webhook events.
Early preview of upcoming product
The following documentation is an early preview of Belvo's upcoming Investments product. As such:
- Parameter key names, values, and structure may change before the final product is implemented.
Historical update
As soon as your banking link is created, we asynchronously load the investment accounts available for the link and will send you the following webhook:
| Webhook Code | Description |
|---|---|
| historical_update | The total number of investment accounts found for the link. |
In the webhook payload we include the number of investment accounts found for the link.
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "INVESTMENTS",
"process_type": "historical_update",
"webhook_code": "historical_update",
"link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
"request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
"external_id": "your_external_id",
"data": {
"total_investments": 5 // Total number of investment accounts found.
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET 'https://api.belvo.com/api/br/investments/?link=link_id' \
-u [Secret Key ID]:[Secret Key PASSWORD]
| Query Parameter | Description | Example |
|---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
New investment available
According to your chosen refresh rate, Belvo will asynchronously retrieve data about any new investment accounts that have appeared for the given link since the last update.
| Webhook Code | Description |
|---|---|
new_investments_available | The number of new accounts found in the institution since the last update. |
In the webhook payload we include the number of new accounts found for the link.
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "ACCOUNTS",
"process_type": "recurrent_update",
"webhook_code": "new_investments_available",
"link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
"request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
"external_id": "your_external_id",
"data": {
"new_investments": 1 // New investment accounts found for the link
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET 'https://api.belvo.com/api/br/investments/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]
| Query Parameter | Description | Example |
|---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
Updated 6 days ago