{"title":"Manage disbursements","category":"default","creationDate":1776961628,"content":"<p>After the grant amount is disbursed to your user, you can retrieve information about a particular disbursement and update its configurations.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You must have an Adyen for Platforms integration with the Capital financial product enabled.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>API credentials<\/strong><\/td>\n<td style=\"text-align: left;\">You must have a <a href=\"\/pt\/capital\/manage-access#api-credentials\">Balance Platform API key<\/a> (for example, <span translate=\"no\"><strong>ws[_123456]@BalancePlatform.[YourBalancePlatform]<\/strong><\/span>) to access the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Capital API<\/a>.<br\/><br\/>Your API credential must have the following roles: <ul><li><strong>Balance Platform Capital Configuration role<\/strong><\/li><li><strong>Balance Platform Capital Grant Initiation role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Capabilities<\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that your user have the following <a href=\"\/pt\/capital\/manage-user-capabilities\">capabilities<\/a>: <ul><li><span translate=\"no\"><strong>getGrantOffers<\/strong><\/span><\/li><li><span translate=\"no\"><strong>receiveGrants<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\"><ul><li>Your user must operate in one of the <a href=\"\/pt\/capital#supported-countriesregions\">supported countries\/regions<\/a>.<\/li><li>Currently, only one disbursement per grant is allowed. We are working on enabling multiple disbursements to different balance accounts.<\/li><li>Unscheduled repayments are only available for users operating in Europe, the United Kingdom, and the United States.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin, make sure: <ul><li>You reached out to your Adyen contact to set up the necessary configurations to add the Capital financial product to your integration. For more details, see our <a href=\"\/pt\/capital\/integration-checklist\">Integration checklist<\/a>.<\/li><li>You followed our <a href=\"\/pt\/capital\/compliance-guidelines\">compliance guidelines for Capital<\/a> when creating user interfaces, marketing materials, and other processes.<\/li><li>Your user <a href=\"\/pt\/capital\/get-grant-offers\">selected a grant offer<\/a> and <a href=\"\/pt\/capital\/terms-of-service\">signed the Terms of Service<\/a>.<\/li><li>You <a href=\"\/pt\/capital\/make-grant-request\">disbursed at least one grant<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"get-all-disbursements\">Get all disbursements of a grant<\/h2>\n<p>To get all disbursements related to a grant:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grants\/{grantId}\/disbursements<\/a> request with the receiving  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#path-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get all disbursements of a grant'\" :id=\"'get-all-disbursements'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/capital\\\/v1\\\/grants\\\/GR00000000000000000000001\\\/disbursements \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the response, note the following parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-accountHolderId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountHolderId<\/a><\/td>\n<td>The unique identifier of the account holder that received the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td>An object containing the amount of the disbursement, in <a href=\"\/pt\/development-resources\/currency-codes\">minor units<\/a>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-balanceAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balanceAccountId<\/a><\/td>\n<td>The unique identifier of the balance account that received the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-balances\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances<\/a><\/td>\n<td>An object containing the balances of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-fee\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fee<\/a><\/td>\n<td>An object containing the fee that your user must pay for the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-fundsCollections\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fundsCollections<\/a><\/td>\n<td>An object containing the accounts that Adyen uses to collect funds related to repayments.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-disbursements-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a><\/td>\n<td>The unique identifier of the grant related to the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-disbursements-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disbursementsId<\/a><\/td>\n<td>The unique identifier of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements#responses-200-repayment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">repayment<\/a><\/td>\n<td>An object containing the <a href=\"https:\/\/www.investopedia.com\/terms\/b\/basispoint.asp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">basis points<\/a> configured for repaying the disbursement.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'get-disbursements-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"disbursements\\\": [\\n        {\\n            \\\"id\\\": \\\"CPTL00000000000000000000001\\\",\\n            \\\"grantId\\\": \\\"GR00000000000000000000001\\\",\\n            \\\"accountHolderId\\\": \\\"AH00000000000000000000001\\\",\\n            \\\"balanceAccountId\\\": \\\"BA00000000000000000000001\\\",\\n            \\\"repayment\\\": {\\n                \\\"basisPoints\\\": 500\\n            },\\n            \\\"balances\\\": {\\n                \\\"principal\\\": -748379,\\n                \\\"fee\\\": -74837,\\n                \\\"total\\\": -823216,\\n                \\\"currency\\\": \\\"EUR\\\"\\n            },\\n            \\\"amount\\\": {\\n                \\\"value\\\": 748379,\\n                \\\"currency\\\": \\\"EUR\\\"\\n            },\\n            \\\"fee\\\": {\\n                \\\"amount\\\": {\\n                    \\\"value\\\": 74837,\\n                    \\\"currency\\\": \\\"EUR\\\"\\n                }\\n            },\\n            \\\"fundsCollections\\\": [\\n                {\\n                    \\\"fundsCollectionType\\\": \\\"UnscheduledRepayment\\\",\\n                    \\\"accountIdentification\\\": {\\n                        \\\"type\\\": \\\"iban\\\",\\n                        \\\"iban\\\": \\\"NL000000000001\\\"\\n                    }\\n                }\\n            ]\\n        }\\n    ]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"update-disbursement\">Update repayment configuration of a disbursement<\/h2>\n<p>You can update the repayment configuration of a specific disbursement. Specifically, you can change the percentage of your user's incoming net volume that is deducted for repaying the grant. To do this:<\/p>\n<ol>\n<li>\n<p>Make a PATCH  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grants\/{grantId}\/disbursements\/{disbursementId}<\/a> request specifying the following parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Parameter type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#path-disbursementId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disbursementId<\/a><\/td>\n<td>Path<\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The unique identifier of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#path-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a><\/td>\n<td>Path<\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The identifier of the grant reference.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#request-repayment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">repayment<\/a><\/td>\n<td>Request<\/td>\n<td><\/td>\n<td>An object containing the <a href=\"https:\/\/www.investopedia.com\/terms\/b\/basispoint.asp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">basis points<\/a> configured for repaying the disbursement.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Here's an example of how to update the repayment configuration of a specific disbursement.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Update repayment configuration of a disbursement'\" :id=\"'update-disbursement'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/capital\\\/v1\\\/grants\\\/GR00000000000000000000001\\\/disbursements\\\/CPTL00000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X PATCH \\\\\\n-d '{\\n     \\&quot;repayment\\&quot;: {\\n        \\&quot;basisPoints\\&quot;: 5000\\n     }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the response, note the following parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-accountHolderId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountHolderId<\/a><\/td>\n<td>The unique identifier of the account holder that received the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td>An object containing the amount of the disbursement, in <a href=\"\/pt\/development-resources\/currency-codes\">minor units<\/a>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-balanceAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balanceAccountId<\/a><\/td>\n<td>The unique identifier of the balance account that received the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-balances\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances<\/a><\/td>\n<td>An object containing the balances of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-fee\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fee<\/a><\/td>\n<td>An object containing the fee that your user must pay for the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-fundsCollections\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fundsCollections<\/a><\/td>\n<td>An object containing the accounts that Adyen uses to collect funds related to repayments.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a><\/td>\n<td>The unique identifier of the grant related to the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-disbursementId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disbursementId<\/a><\/td>\n<td>The unique identifier of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/patch\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-repayment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">repayment<\/a><\/td>\n<td>An object containing the <a href=\"https:\/\/www.investopedia.com\/terms\/b\/basispoint.asp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">basis points<\/a> configured for repaying the disbursement.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'update-disbursement-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"id\\\": \\\"CPTL00000000000000000000001\\\",\\n    \\\"grantId\\\": \\\"GR00000000000000000000001\\\",\\n    \\\"accountHolderId\\\": \\\"AH00000000000000000000001\\\",\\n    \\\"balanceAccountId\\\": \\\"BA00000000000000000000001\\\",\\n    \\\"repayment\\\": {\\n        \\\"basisPoints\\\": 5000\\n    },\\n    \\\"balances\\\": {\\n        \\\"principal\\\": -639,\\n        \\\"fee\\\": -89,\\n        \\\"total\\\": -728,\\n        \\\"currency\\\": \\\"EUR\\\"\\n    },\\n    \\\"amount\\\": {\\n        \\\"value\\\": 639,\\n        \\\"currency\\\": \\\"EUR\\\"\\n    },\\n    \\\"fee\\\": {\\n        \\\"amount\\\": {\\n            \\\"value\\\": 89,\\n            \\\"currency\\\": \\\"EUR\\\"\\n        }\\n    },\\n    \\\"fundsCollections\\\": [\\n        {\\n            \\\"fundsCollectionType\\\": \\\"UnscheduledRepayment\\\",\\n            \\\"accountIdentification\\\": {\\n                \\\"type\\\": \\\"iban\\\",\\n                \\\"iban\\\": \\\"NL000000000001\\\"\\n            }\\n        }\\n    ]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"unscheduled-repayments\">Retrieve bank account details for unscheduled repayments<\/h2>\n<p>Users can make unscheduled payments to repay their grant using the dedicated bank account details (for example, IBAN) assigned to each disbursement. You can retrieve these bank account details by making an API call. Then, you can share the information with your users.<\/p>\n<p>To retrieve bank account details for a particular disbursement:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grants\/{grantId}\/disbursements\/{disbursementId}<\/a> request, specifying the following path parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)#path-disbursementId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disbursementId<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The unique identifier of the disbursement.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)#path-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The identifier of the grant reference.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Retrieve bank account details for unscheduled repayments'\" :id=\"'get-iban-unscheduled-repayments'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/capital\\\/v1\\\/grants\\\/GR00000000000000000000001\\\/disbursements\\\/CPTL00000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the response, note the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-fundsCollections\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fundsCollections<\/a>  object containing the following parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-fundsCollections-accountIdentification\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fundsCollections.accountIdentification<\/a><\/td>\n<td>An object containing the identification information of the account to which your user can transfer funds related to unscheduled repayments. For example, the international bank account number (IBAN).<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\/disbursements\/(disbursementId)#responses-200-fundsCollections-fundsCollectionType\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fundsCollections.type<\/a><\/td>\n<td>The type of funds collection. Must be set to <span translate=\"no\"><strong>UnscheduledRepayment<\/strong><\/span>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'fundsCollections object'\" :id=\"'funds-collections-object'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"fundsCollections\\\": [\\n        {\\n            \\\"fundsCollectionType\\\": \\\"UnscheduledRepayment\\\",\\n            \\\"accountIdentification\\\": {\\n                \\\"type\\\": \\\"iban\\\",\\n                \\\"iban\\\": \\\"NL000000000001\\\"\\n            }\\n        }\\n    ]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/capital\/grant-lifecycle-and-status\"\n                        target=\"_self\"\n                        >\n                    Grant lifecycle and status\n                <\/a><\/li><li><a href=\"\/capital\/get-grant-balances\"\n                        target=\"_self\"\n                        >\n                    Get grant details\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/capital\/manage-disbursements","articleFields":{"description":"Learn how to get and update configurations of a disbursement.","feedback_component":true,"type":"page","_expandable":{"operations":""},"status":"current","parameters":{"directoryPath":"\/capital","financialProduct":"capital"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/capital\/manage-disbursements","title":"Manage disbursements","content":"After the grant amount is disbursed to your user, you can retrieve information about a particular disbursement and update its configurations.\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 with the Capital financial product enabled.\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 have the following capabilities: getGrantOffersreceiveGrants\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.Unscheduled repayments are only available for users operating in Europe, the United Kingdom, and the United States.\n\n\nSetup steps\nBefore you begin, make sure: You reached out to your Adyen contact to set up the necessary configurations to add the Capital financial product to your integration. For more details, see our Integration checklist.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.You disbursed at least one grant.\n\n\n\nGet all disbursements of a grant\nTo get all disbursements related to a grant:\n\n\nMake a GET  \/grants\/{grantId}\/disbursements request with the receiving  grantId.\n\n\n\n\n\nIn the response, note the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n accountHolderId\nThe unique identifier of the account holder that received the disbursement.\n\n\n amount\nAn object containing the amount of the disbursement, in minor units.\n\n\n balanceAccountId\nThe unique identifier of the balance account that received the disbursement.\n\n\n balances\nAn object containing the balances of the disbursement.\n\n\n fee\nAn object containing the fee that your user must pay for the disbursement.\n\n\n fundsCollections\nAn object containing the accounts that Adyen uses to collect funds related to repayments.\n\n\n grantId\nThe unique identifier of the grant related to the disbursement.\n\n\n disbursementsId\nThe unique identifier of the disbursement.\n\n\n repayment\nAn object containing the basis points configured for repaying the disbursement.\n\n\n\n\n\n\n\n\nUpdate repayment configuration of a disbursement\nYou can update the repayment configuration of a specific disbursement. Specifically, you can change the percentage of your user's incoming net volume that is deducted for repaying the grant. To do this:\n\n\nMake a PATCH  \/grants\/{grantId}\/disbursements\/{disbursementId} request specifying the following parameters:\n\n\n\nParameter\nParameter type\nRequired\nDescription\n\n\n\n\n disbursementId\nPath\n\nThe unique identifier of the disbursement.\n\n\n grantId\nPath\n\nThe identifier of the grant reference.\n\n\n repayment\nRequest\n\nAn object containing the basis points configured for repaying the disbursement.\n\n\n\nHere's an example of how to update the repayment configuration of a specific disbursement.\n\n\n\n\n\nIn the response, note the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n accountHolderId\nThe unique identifier of the account holder that received the disbursement.\n\n\n amount\nAn object containing the amount of the disbursement, in minor units.\n\n\n balanceAccountId\nThe unique identifier of the balance account that received the disbursement.\n\n\n balances\nAn object containing the balances of the disbursement.\n\n\n fee\nAn object containing the fee that your user must pay for the disbursement.\n\n\n fundsCollections\nAn object containing the accounts that Adyen uses to collect funds related to repayments.\n\n\n grantId\nThe unique identifier of the grant related to the disbursement.\n\n\n disbursementId\nThe unique identifier of the disbursement.\n\n\n repayment\nAn object containing the basis points configured for repaying the disbursement.\n\n\n\n\n\n\n\n\nRetrieve bank account details for unscheduled repayments\nUsers can make unscheduled payments to repay their grant using the dedicated bank account details (for example, IBAN) assigned to each disbursement. You can retrieve these bank account details by making an API call. Then, you can share the information with your users.\nTo retrieve bank account details for a particular disbursement:\n\n\nMake a GET  \/grants\/{grantId}\/disbursements\/{disbursementId} request, specifying the following path parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n disbursementId\n\nThe unique identifier of the disbursement.\n\n\n grantId\n\nThe identifier of the grant reference.\n\n\n\n\n\n\n\n\nIn the response, note the  fundsCollections  object containing the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n fundsCollections.accountIdentification\nAn object containing the identification information of the account to which your user can transfer funds related to unscheduled repayments. For example, the international bank account number (IBAN).\n\n\n fundsCollections.type\nThe type of funds collection. Must be set to UnscheduledRepayment.\n\n\n\n\n\n\n\n\nSee also\n\n\n                    Grant lifecycle and status\n                \n                    Get grant details\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Capital","lvl2":"Manage disbursements"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/capital","lvl2":"\/pt\/capital\/manage-disbursements"},"levels":3,"category":"","category_color":"","tags":["Manage","disbursements"]}}