To keep track of business financing-related events in your balance platform, you can subscribe to the following webhook types:
- Capital webhooks, including Capital offer webhook and Capital grant webhook: These notify your server about changes to grants throughout their lifecycle.
- Transfer webhooks: These notify your server about incoming and outgoing transfers related to grants in your platform.
- Transaction webhooks: These notify your server when grant funds are deposited into a user's balance or credited for grant repayment.
You can differentiate the events based on the type. Additionally, these webhooks include a status field that indicates the outcome of each event. To learn more about common webhook structure, see the Platform webhooks documentation.
The following diagram outlines the types of webhooks you can expect during the grant lifecycle. Note that grant initiation status updates generate only capital notifications, not transfer or transaction notifications.
Capital offer webhook
Use Capital offer webhooks to get notified when grant offers are created for account holders in your platform.
| Event type | Description |
|---|---|
| balancePlatform.balanceAccountHolder.capitalOffer.created | After grant offers are created for an account holder, Adyen sends this webhook with information about the offers. |
Capital grant webhook
Use Capital grant webhooks to track lifecycle of grants in your platform.
| Event type | Description |
|---|---|
| balancePlatform.grants.created | After a grant is created for an account holder, Adyen sends this webhook with information about the grant. |
| balancePlatform.grants.updated | After a grant is updated for an account holder, Adyen sends this webhook with information about the grant. |
Transfer webhook
Use Transfer webhooks to track the movement of funds, both incoming and outgoing, related to grants in your platform, from initiation to completion.
| Event type | Description |
|---|---|
| balancePlatform.transfer.created | Adyen sends this webhook when there are fund movements on your platform. |
| balancePlatform.transfer.updated | Adyen sends this webhook when the status of a transfer changes. |
You can identify transfer webhooks triggered by grant-related events by looking at the following values:
| Parameter | Description | Value |
|---|---|---|
| category | The category of the transfer. | grants |
| type | The type of the transfer. |
|
| direction | The direction of the transfer request from the perspective of the balance account. |
|
| counterparty | The other party in the transfer. |
|
Transaction webhook
Use Transaction webhooks to confirm when grant funds are deposited into a user's balance or credited for grant repayment.
| Event type | Description |
|---|---|
| balancePlatform.transaction.created | After a transfer is booked in a balance account, Adyen sends this webhook with information about the transaction. |
You can identify transaction webhook triggered by grant-related events by looking at the following values:
| Parameter | Description | Value |
|---|---|---|
| transfer.id | The unique identifier of the transfer. | Must correspond to the transfer ID created for the grant fund movement. |
| transfer.reference | The reference from the /transfers request. |
Must correspond to the grant ID listed in the related transfer. |