- \n
- Capital dynamic offer webhook<\/strong><\/li>\n
- Capital static offer webhook<\/strong><\/li>\n
- Capital grant webhook<\/strong><\/li>\n<\/ul><\/li>\n
- Transfer webhooks<\/a>: These notify your server about incoming and outgoing transfers related to grants in your platform.<\/li>\n
- Transaction webhooks<\/a>: These notify your server when grant funds are deposited into a user's balance or credited for grant repayment.<\/li>\n<\/ul>\n
You can differentiate the events based on the
type<\/code>. Additionally, these webhooks include astatus<\/code> field that indicates the outcome of each event. To learn more about common webhook structure, see the Platform webhooks documentation<\/a>.<\/p>\nThe 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.<\/p>\n
\n
![\"Grant](\"\/user\/pages\/docs\/07.capital\/08.webhook-types\/grant-lifecycle-and-webhooks.svg\")
\n<\/a><\/p>\nCapital dynamic offer webhook<\/h2>\n
Use Capital dynamic offer webhook to get notified when dynamic offers<\/a> are created for account holders in your platform.<\/p>\n
\n\n
\n \nEvent type<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n balancePlatform.capital.dynamicOffer.created<\/a><\/td>\n After dynamic offers are created for an account holder, Adyen sends this webhook with information about the offers.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Capital static offer webhook<\/h2>\n
Use Capital static offer webhook to get notified when static offers<\/a> are created for account holders in your platform.<\/p>\n
\n\n
\n \nEvent type<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n balancePlatform.balanceAccountHolder.capitalOffer.created<\/a><\/td>\n After static offers are created for an account holder, Adyen sends this webhook with information about the offers.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Capital grant webhook<\/h2>\n
Use Capital grant webhooks to track lifecycle of grants<\/a> in your platform.<\/p>\n
\n\n
\n \nEvent type<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n balancePlatform.grants.created<\/a><\/td>\n After a grant is created for an account holder, Adyen sends this webhook with information about the grant.<\/td>\n<\/tr>\n \n balancePlatform.grants.updated<\/a><\/td>\n After a grant is updated for an account holder, Adyen sends this webhook with information about the grant.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Transfer webhook<\/h2>\n
Use Transfer webhooks to track the movement of funds, both incoming and outgoing, related to grants in your platform, from initiation to completion.<\/p>\n
\n\n
\n \nEvent type<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n balancePlatform.transfer.created<\/a><\/td>\n Adyen sends this webhook when there are fund movements on your platform.<\/td>\n<\/tr>\n \n balancePlatform.transfer.updated<\/a><\/td>\n Adyen sends this webhook when the status of a transfer changes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n To identify Transfer webhooks triggered by grant-related events, review the following values:<\/p>\n
\n\n
\n \nParameter<\/th>\n Description<\/th>\n Value<\/th>\n<\/tr>\n<\/thead>\n \n category<\/a><\/td>\n The category of the transfer.<\/td>\n grants<\/strong><\/span><\/td>\n<\/tr>\n \n type<\/a><\/td>\n The type of the transfer.<\/td>\n - Grant disbursement: grant<\/strong><\/span><\/li>
- Regural grant repayment: repayment<\/strong><\/span><\/li>
- Unscheduled grant repayment: capitalFundsCollection<\/strong><\/span> and repayment<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n
\n direction<\/a><\/td>\n The direction of the transfer request from the perspective of the balance account.<\/td>\n - Grant disbursement: incoming<\/strong><\/span><\/li>
- Regural grant repayment: outgoing<\/strong><\/span><\/li>
- Unscheduled grant repayment: incoming<\/strong><\/span> and outgoing<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n
\n counterparty<\/a><\/td>\n The other party in the transfer.<\/td>\n - balanceAccountId<\/strong><\/span><\/li>
- transferInstrumentId<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Transaction webhook<\/h2>\n
Use Transaction webhooks to confirm when grant funds are deposited into a user's balance or credited for grant repayment.<\/p>\n
\n\n
\n \nEvent type<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n balancePlatform.transaction.created<\/a><\/td>\n After a transfer is booked in a balance account, Adyen sends this webhook with information about the transaction.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n To identify Transaction webhooks triggered by grant-related events, review the following values:<\/p>\n
\n\n
\n \nParameter<\/th>\n Description<\/th>\n Value<\/th>\n<\/tr>\n<\/thead>\n \n transfer.id<\/a><\/td>\n The unique identifier of the transfer.<\/td>\n Must correspond to the transfer ID created for the grant fund movement.<\/td>\n<\/tr>\n \n transfer.reference<\/a><\/td>\n The reference from the \/transfers<\/code> request.<\/td>\nMust correspond to the grant ID listed in the related transfer.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/capital\/webhook-types","articleFields":{"description":"Learn which webhooks Adyen sends for business financing-related events.","section_label":"Webhooks","feedback_component":true,"type":"page","_expandable":{"operations":""},"status":"current","next_steps":[{"title":"Grant lifecycle-related events","description":"Learn which webhooks Adyen sends for updates on grant lifecycle.","url":"\/capital\/webhook-types\/capital-webhooks","required":false},{"title":"Fund transfers-related webhooks","description":"Learn which webhooks Adyen sends for updates on grant fund transfers.","url":"\/capital\/webhook-types\/fund-transfers-webhooks","required":false}],"parameters":{"directoryPath":"\/capital","financialProduct":"capital","model":"platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/capital\/webhook-types","title":"Webhook structures and types for Capital","content":"To keep track of business financing-related events in your balance platform, you can subscribe to the following webhook types:\n\n Capital webhooks: These notify your server of changes to grants at each stage of their lifecycle. The following webhooks are included:\n\nCapital dynamic offer webhook\nCapital static offer webhook\nCapital grant webhook\n\n Transfer webhooks: These notify your server about incoming and outgoing transfers related to grants in your platform.\n Transaction webhooks: These notify your server when grant funds are deposited into a user's balance or credited for grant repayment.\n\nYou 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.\nThe 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.\n\n \n\nCapital dynamic offer webhook\nUse Capital dynamic offer webhook to get notified when dynamic offers are created for account holders in your platform.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.capital.dynamicOffer.created\nAfter dynamic offers are created for an account holder, Adyen sends this webhook with information about the offers.\n\n\n\nCapital static offer webhook\nUse Capital static offer webhook to get notified when static offers are created for account holders in your platform.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.balanceAccountHolder.capitalOffer.created\nAfter static offers are created for an account holder, Adyen sends this webhook with information about the offers.\n\n\n\nCapital grant webhook\nUse Capital grant webhooks to track lifecycle of grants in your platform.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.grants.created\nAfter a grant is created for an account holder, Adyen sends this webhook with information about the grant.\n\n\n balancePlatform.grants.updated\nAfter a grant is updated for an account holder, Adyen sends this webhook with information about the grant.\n\n\n\nTransfer webhook\nUse Transfer webhooks to track the movement of funds, both incoming and outgoing, related to grants in your platform, from initiation to completion.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.transfer.created\nAdyen sends this webhook when there are fund movements on your platform.\n\n\n balancePlatform.transfer.updated\nAdyen sends this webhook when the status of a transfer changes.\n\n\n\nTo identify Transfer webhooks triggered by grant-related events, review the following values:\n\n\n\nParameter\nDescription\nValue\n\n\n\n\n category\nThe category of the transfer.\ngrants\n\n\n type\nThe type of the transfer.\nGrant disbursement: grantRegural grant repayment: repaymentUnscheduled grant repayment: capitalFundsCollection and repayment\n\n\n direction\nThe direction of the transfer request from the perspective of the balance account.\nGrant disbursement: incomingRegural grant repayment: outgoingUnscheduled grant repayment: incoming and outgoing\n\n\n counterparty\nThe other party in the transfer.\nbalanceAccountIdtransferInstrumentId\n\n\n\nTransaction webhook\nUse Transaction webhooks to confirm when grant funds are deposited into a user's balance or credited for grant repayment.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.transaction.created\nAfter a transfer is booked in a balance account, Adyen sends this webhook with information about the transaction.\n\n\n\nTo identify Transaction webhooks triggered by grant-related events, review the following values:\n\n\n\nParameter\nDescription\nValue\n\n\n\n\n transfer.id\nThe unique identifier of the transfer.\nMust correspond to the transfer ID created for the grant fund movement.\n\n\n transfer.reference\nThe reference from the \/transfers request.\nMust correspond to the grant ID listed in the related transfer.\n\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Capital","lvl2":"Webhook structures and types for Capital"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/capital","lvl2":"\/pt\/capital\/webhook-types"},"levels":3,"category":"","category_color":"","tags":["Webhook","structures","types","Capital"]},"articleFiles":{"grant-lifecycle-and-webhooks.svg":" ![\"\"](\"https:\/\/docs.adyen.com\/user\/pages\/docs\/07.capital\/08.webhook-types\/grant-lifecycle-and-webhooks.svg\")
"}}
- transferInstrumentId<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
- Regural grant repayment: outgoing<\/strong><\/span><\/li>
- Regural grant repayment: repayment<\/strong><\/span><\/li>
- Capital static offer webhook<\/strong><\/li>\n