\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n","url":"https:\/\/docs.adyen.com\/capital\/make-grant-request","articleFields":{"description":"Learn how to make a request for a grant and disburse the funds to your user's account.","feedback_component":true,"id":"25142879","type":"page","_expandable":{"operations":""},"status":"current","next_steps":[{"title":"Get grant details","description":"Learn how to get information about all grants in your balance platform.","url":"\/capital\/get-grant-balances","required":false},{"title":"Manage disbursements","description":"Learn how to get and update configurations of a disbursement.","url":"\/capital\/manage-disbursements","required":false}],"parameters":{"directoryPath":"\/capital","financialProduct":"capital"}},"algolia":{"url":"https:\/\/docs.adyen.com\/capital\/make-grant-request","title":"Disburse a grant","content":"After your user selects a grant offer and signs the Terms of Service, you can make an API request to configure the grant for the user. If the request is successful, then Adyen initiates a transfer to settle the grant funds in your user\u2019s balance account.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have an Adyen for Platforms integration that supports Capital.\n\n\nAPI credentials\nYou must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the Capital API.Your API credential must have the following roles: Balance Platform Capital Configuration roleBalance Platform Capital Grant Initiation role\n\n\nCapabilities\nMake sure that your user has the following capabilities: getGrantOffersreceiveGrants\n\n\nWebhooks\nSubscribe to the following webhooks: Capital webhooks Transfer webhooks\n\n\nLimitations\nYour user must operate in one of the supported countries\/regions.Currently, only one disbursement per grant is allowed. We are working on enabling multiple disbursements to different balance accounts.\n\n\nSetup steps\nBefore you begin, make sure: You followed our compliance guidelines for Capital when creating user interfaces, marketing materials, and other processes.Your user selected a grant offer and signed the Terms of Service.\n\n\n\n1. Configure a grant\n\nTo renew an active grant, see Renew a grant.\n\nTo configure a grant:\n\n\nMake a POST \/grants request, specifying the following parameters:\n\n\n\nParameter\nType\nRequired\nDescription\n\n\n\n\n counterparty.balanceAccountId\nString\n\nThe unique identifier of the balance account that belongs to the receiving account holder. Pass this parameter if you choose to pay out to the balance account of the user.If balanceAccountId is not provided in the request, the grant is paid out to the account holder's primaryBalanceAccount.\n\n\n counterparty.transferInstrumentId\nString\n\nThe unique identifier of the transfer instrument that belongs to the legal entity of the account holder. Pass this parameter if you choose to pay out to the transfer instrument of the user.\n\n\n grantAccountId\nString\n\nThe unique identifier of the grant account. Reach out to your Adyen contact to get this value.\n\n\n grantOfferId\nString\n\nThe unique identifier of the grant offer that has been selected by the user.\n\n\n\n Required Conditionally required\nThe following example shows how to disburse a grant to the specified balance account.\n\n\n\n\n\nIn the response, note the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n balances\nAn object that contains the grant balances.\n\n\n id\nThe unique identifier of the grant.\n\n\n grantAccountId\nThe identifier of the grant account used to account for the grant.\n\n\n grantOfferId\nThe unique identifier for the related grant offer, which determines the grant conditions.\n\n\n counterparty\nAn object that contains the details of the receiving account holder.\n\n\n status\nThe status of the grant.\n\n\n\n\n\n\n\n\nRequests using POST \/grants are processed asynchronously. You will receive a response to your API request, but you must wait for the webhook to know the final result of a request.\n2. Get updates\nAdyen sends the webhook messages for the following event types to your server to update you about the grant and fund transfer status.\n\n\n\nEvent type\nDescription\n\n\n\n\n balancePlatform.grants.created\nThe grant has been configured.\n\n\n balancePlatform.grants.updated\nThe grant has been fully repaid, reconfigured, or written off in case the user did not pay back all outstanding funds.\n\n\n balancePlatform.transfer.created\nThe outgoing or incoming grant transfer request has been received.\n\n\n balancePlatform.transfer.updated\nThe outgoing or incoming grant transfer request has been authorized and\/or booked.\n\n\n balancePlatform.transaction.created\nThe funds have been paid out to the balance account or the payment instrument.\n\n\n\nTo keep track of webhooks, make sure that your server can receive and accept webhooks.\n\n\n \n \n \n \n\n","type":"page","locale":"en","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Capital","lvl2":"Disburse a grant"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/capital","lvl2":"\/capital\/make-grant-request"},"levels":3,"category":"","category_color":"","tags":["Disburse","grant"]}}
![\"Required\"](\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&fetchpriority=auto\")
<\/span><\/td>\n![\"This](\"\/user\/pages\/reuse\/image-library\/01.icons\/capital-legend\/required.svg?decoding=auto&fetchpriority=auto\")
Required ![\"This](\"\/user\/pages\/reuse\/image-library\/01.icons\/capital-legend\/conditionally-required.svg?decoding=auto&fetchpriority=auto\")
Conditionally required<\/p>\n