Investment Transactions (Webhooks)
Reference information for our Investment Transactions 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 transactions available for the link and will send you the following webhook:
| Webhook Code | Description |
|---|---|
| historical_update | The total number of investment transactions for the link for the past year. |
In the webhook payload we include the number of investment transactions found for the link (including the number of inflow and outflow transactions) as well as the date range that the information applies to.
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "INVESTMENT_TRANSACTIONS",
"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_transactions": 19, // Total number of transactions found
"total_inflow_transactions": 10, // Total number of inflow transactions
"total_outflow_transactions": 9, // Total number of outflow transactions
"first_transaction_date": "2023-01-03", // First transaction date
"last_transaction_date": "2024-01-03" // Last transaction date
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET \
-u [Secret Key ID]:[Secret Key PASSWORD] \
'https://api.belvo.com/api/br/investment-transactions/?link=link_id'
| Query Parameter | Description | Example |
|---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
You can add further filters to narrow down the results, for example:
curl --request GET \
-u [Secret Key ID]:[Secret Key PASSWORD] \
'https://api.belvo.com/api/br/investment-transactions/?link=link_id&type=INFLOW'
| Query Parameter | Description | Example |
|---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
type | The type of transaction. Can be either INFLOW or OUTFLOW. | INFLOW |
New transactions available
According to your chosen refresh rate, Belvo will asynchronously retrieve data about any new investment transactions that have appeared for the given link since the last update.
We define new investment transactions as transactions found in the institution for a given link since the last update. For example, these could be new investment transactions from the last 24 hours or new investment transactions from a few days ago that were only just added by the institution.
| Webhook Code | Description |
|---|---|
new_investment_transactions_available | The number of new investment transactions found in the institution since the last update. |
In the webhook payload we include the number of new transactions found for the link.
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "INVESTMENT_TRANSACTIONS",
"process_type": "recurrent_update",
"webhook_code": "new_investment_transactions_available",
"link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
"request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
"external_id": "your_external_id",
"data": {
"new_investment_transactions": 19 // Number of new transactions found since last event
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET \
-u [Secret Key ID]:[Secret Key PASSWORD] \
'https://api.belvo.com/api/br/investment-transactions/?link=link_id&type=INFLOW&created_at__range=date1,date2'
| Query Parameter | Description | Example |
|---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
created_at__range | The date range you want to receive transactions for. We recommend that date1 is the date when you previously received a notification and date2 is the date when you receive the current notification (both in YYYY-MM-DD format). | 2024-05-01,2024-06-01 |
Updated 6 days ago