{"title":"Get grant details","category":"default","creationDate":1776961628,"content":"<p>After you successfully create a grant, you can get the details of these grants by making API requests. These details include, for example, the grant balances, repayment configuration, and status.<\/p>\n<p>You can use this information to:<\/p>\n<ul>\n<li>Show your user the details of their grant.<\/li>\n<li>Track whether your user is repaying their grant.<\/li>\n<\/ul>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements 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#manage-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>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">Your user must operate in one of the <a href=\"\/pt\/capital#supported-countriesregions\">supported countries\/regions<\/a>.<\/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=\"grants-ah\">Get all grants of an account holder<\/h2>\n<p>You can get the details of all the grants given to a specific account holder. To do so:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grants<\/a> request with the receiving  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#query-counterpartyAccountHolderId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">counterpartyAccountHolderId<\/a> as a query parameter.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get all grant references of an account holder'\" :id=\"'get-all-grants-account-holder'\" :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?counterpartyAccountHolderId=AH00000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d ''&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 <code>grants<\/code> array, which includes an object for each grant associated to the account holder. Each object includes 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#responses-200-grants-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">id<\/a><\/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\/get\/grants#responses-200-grants-grantAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantAccountId<\/a><\/td>\n<td>The identifier of the grant account used to account for the grant.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-grantOfferId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantOfferId<\/a><\/td>\n<td>The identifier of the grant offer that has been selected by the receiving account holder.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-counterparty\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">counterparty<\/a><\/td>\n<td>An object containing the details of the receiving account holder.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-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 grant, 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#responses-200-grants-fee\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fee<\/a><\/td>\n<td>An object containing the fee amount.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-repayment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">repayment<\/a><\/td>\n<td>An object containing the repayment amount, in <a href=\"https:\/\/www.investopedia.com\/terms\/b\/basispoint.asp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">basis points<\/a>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-balances\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances<\/a><\/td>\n<td>An object containing the details of the existing grant.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants#responses-200-grants-status\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">status<\/a><\/td>\n<td>The status of the grant.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'get-all-grants'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"grants\\\": [\\n        {\\n            \\\"id\\\": \\\"GR322XC22322625HQ7NCX2FWJ\\\",\\n            \\\"amount\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"value\\\": 310534\\n            },\\n            \\\"counterparty\\\": {\\n                \\\"accountHolderId\\\": \\\"AH322XC22349655HQ7NCSFJMQ\\\",\\n                \\\"balanceAccountId\\\": \\\"BA322XC22349655HQ7NCSFJNV\\\"\\n            },\\n            \\\"fee\\\": {\\n                \\\"amount\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"value\\\": 31053\\n                }\\n            },\\n            \\\"grantAccountId\\\": \\\"CG322LZ223222B5F6SFQWBANK\\\",\\n            \\\"repayment\\\": {\\n                \\\"basisPoints\\\": 500\\n            },\\n            \\\"balances\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"fee\\\": 31053,\\n                \\\"principal\\\": 310534,\\n                \\\"total\\\": 341587\\n            },\\n            \\\"status\\\": \\\"Active\\\"\\n        },\\n        {\\n            \\\"id\\\": \\\"GR322XC39137294KQ1NCX4MWR\\\",\\n            \\\"amount\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"value\\\": 31053\\n            },\\n            \\\"counterparty\\\": {\\n                \\\"accountHolderId\\\": \\\"AH322XC22349655HQ7NCSFJMQ\\\",\\n                \\\"balanceAccountId\\\": \\\"BA322XC22349655HQ7NCSFJNV\\\"\\n            },\\n            \\\"fee\\\": {\\n                \\\"amount\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"value\\\": 3105\\n                }\\n            },\\n            \\\"grantAccountId\\\": \\\"CG322LZ223222B5F6SFQWBANK\\\",\\n            \\\"repayment\\\": {\\n                \\\"basisPoints\\\": 500\\n            },\\n            \\\"balances\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"fee\\\": 0,\\n                \\\"principal\\\": 0,\\n                \\\"total\\\": 0\\n            },\\n            \\\"status\\\": \\\"Repaid\\\"\\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=\"grant-details\">Get details of a specific grant<\/h2>\n<p>To get the balance of a specific grant:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grants\/{grantId}<\/a> request with the receiving  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#path-grantId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantId<\/a> as a query parameter.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get the balances of a grant'\" :id=\"'get-grant-balances'\" :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 \\\\\\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)#responses-200-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">id<\/a><\/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\/get\/grants\/(grantId)#responses-200-grantAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantAccountId<\/a><\/td>\n<td>The identifier of the grant account used to account for the grant.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#responses-200-grantOfferId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">grantOfferId<\/a><\/td>\n<td>The identifier of the grant offer that has been selected by the receiving account holder.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#responses-200-counterparty\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">counterparty<\/a><\/td>\n<td>An object containing the details of the receiving account holder.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#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 grant, 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)#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 amount.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#responses-200-repayment\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">repayment<\/a><\/td>\n<td>An object containing the repayment amount, in <a href=\"https:\/\/www.investopedia.com\/terms\/b\/basispoint.asp\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">basis points<\/a>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#responses-200-balances\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances<\/a><\/td>\n<td>An object containing the details of the existing grant.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grants\/(grantId)#responses-200-status\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">status<\/a><\/td>\n<td>The status of the grant.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"id\\\": \\\"GR00000000000000000000001\\\",\\n    \\\"grantAccountId\\\": \\\"CG00000000000000000000001\\\",\\n    \\\"grantOfferId\\\": \\\"00000000001\\\",\\n    \\\"counterparty\\\": {\\n        \\\"accountHolderId\\\": \\\"AH00000000000000000000001\\\",\\n        \\\"balanceAccountId\\\": \\\"BA00000000000000000000001\\\"\\n    },\\n    \\\"amount\\\": {\\n        \\\"currency\\\": \\\"EUR\\\",\\n        \\\"value\\\": 1000000\\n    },\\n    \\\"fee\\\" : {\\n        \\\"amount\\\" : {\\n            \\\"value\\\" : 120000,\\n            \\\"currency\\\" : \\\"EUR\\\"\\n        }\\n    },\\n    \\\"repayment\\\": {\\n        \\\"basisPoints\\\": 1400\\n    },\\n    \\\"balances\\\": {\\n        \\\"principal\\\": 1000000,\\n        \\\"fee\\\": 120000,\\n        \\\"total\\\": 1120000,\\n        \\\"currency\\\": \\\"EUR\\\"\\n    },\\n    \\\"status\\\": \\\"Active\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"grant-account-details\">Get details of your grant account<\/h2>\n<p>The balances of all grants in your balance platform are tracked by your grant account.<\/p>\n<p>To get the details of your grant account:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grantAccounts\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/grantAccounts\/{id}<\/a> request with the receiving  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grantAccounts\/(id)#path-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">id<\/a> as a query parameter.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get the balances of all grants'\" :id=\"'get-all-grant-balances'\" :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\\\/grantAccounts\\\/CG00000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d ''&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\/grantAccounts\/(id)#responses-200-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">id<\/a><\/td>\n<td>The unique identifier of the grant account.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grantAccounts\/(id)#responses-200-balances\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances<\/a><\/td>\n<td>An object containing the details of all the existing grant(s) on your platform's grant account.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/capital\/latest\/get\/grantAccounts\/(id)#responses-200-limits\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">limits<\/a><\/td>\n<td>An object containing the details about the maximum allowed total amount for all grants on this grant account.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'get-all-grants'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"balances\\\": [\\n        {\\n            \\\"currency\\\": \\\"EUR\\\",\\n            \\\"fee\\\": 120000,\\n            \\\"principal\\\": 1000000,\\n            \\\"total\\\": 1120000\\n        }\\n    ],\\n    \\\"id\\\": \\\"CG00000000000000000000001\\\",\\n    \\\"limits\\\": [\\n        {\\n            \\\"amount\\\": {\\n                \\\"currency\\\": \\\"EUR\\\",\\n                \\\"value\\\": -100000000\\n            }\\n        },\\n        {\\n            \\\"amount\\\": {\\n                \\\"currency\\\": \\\"USD\\\",\\n                \\\"value\\\": -100000000\\n            }\\n        },\\n        {\\n            \\\"amount\\\": {\\n                \\\"currency\\\": \\\"GBP\\\",\\n                \\\"value\\\": -100000000\\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\/manage-disbursements\"\n                        target=\"_self\"\n                        >\n                    Manage disbursements\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/capital\/get-grant-balances","articleFields":{"description":"Learn how to get information about all grants in your balance platform.","feedback_component":true,"id":"25142879","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"26-10-2022 11:36","parameters":{"directoryPath":"\/capital","model":"platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/capital\/get-grant-balances","title":"Get grant details","content":"After you successfully create a grant, you can get the details of these grants by making API requests. These details include, for example, the grant balances, repayment configuration, and status.\nYou can use this information to:\n\nShow your user the details of their grant.\nTrack whether your user is repaying their grant.\n\nRequirements\nBefore you begin, take into account the following requirements 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\nLimitations\nYour user must operate in one of the supported countries\/regions.\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 grants of an account holder\nYou can get the details of all the grants given to a specific account holder. To do so:\n\n\nMake a GET  \/grants request with the receiving  counterpartyAccountHolderId as a query parameter.\n\n\n\n\n\nIn the response, note the grants array, which includes an object for each grant associated to the account holder. Each object includes the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n id\nThe identifier of the grant reference.\n\n\n grantAccountId\nThe identifier of the grant account used to account for the grant.\n\n\n grantOfferId\nThe identifier of the grant offer that has been selected by the receiving account holder.\n\n\n counterparty\nAn object containing the details of the receiving account holder.\n\n\n amount\nAn object containing the amount of the grant, in minor units.\n\n\n fee\nAn object containing the fee amount.\n\n\n repayment\nAn object containing the repayment amount, in basis points.\n\n\n balances\nAn object containing the details of the existing grant.\n\n\n status\nThe status of the grant.\n\n\n\n\n\n\n\n\nGet details of a specific grant\nTo get the balance of a specific grant:\n\n\nMake a GET  \/grants\/{grantId} request with the receiving  grantId as a query parameter.\n\n\n\n\n\nIn the response, note the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n id\nThe identifier of the grant reference.\n\n\n grantAccountId\nThe identifier of the grant account used to account for the grant.\n\n\n grantOfferId\nThe identifier of the grant offer that has been selected by the receiving account holder.\n\n\n counterparty\nAn object containing the details of the receiving account holder.\n\n\n amount\nAn object containing the amount of the grant, in minor units.\n\n\n fee\nAn object containing the fee amount.\n\n\n repayment\nAn object containing the repayment amount, in basis points.\n\n\n balances\nAn object containing the details of the existing grant.\n\n\n status\nThe status of the grant.\n\n\n\n\n\n\n\n\nGet details of your grant account\nThe balances of all grants in your balance platform are tracked by your grant account.\nTo get the details of your grant account:\n\n\nMake a GET  \/grantAccounts\/{id} request with the receiving  id as a query parameter.\n\n\n\n\n\nIn the response, note the following parameters:\n\n\n\nParameter\nDescription\n\n\n\n\n id\nThe unique identifier of the grant account.\n\n\n balances\nAn object containing the details of all the existing grant(s) on your platform's grant account.\n\n\n limits\nAn object containing the details about the maximum allowed total amount for all grants on this grant account.\n\n\n\n\n\n\n\n\nSee also\n\n\n                    Grant lifecycle and status\n                \n                    Manage disbursements\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Capital","lvl2":"Get grant details"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/capital","lvl2":"\/pt\/capital\/get-grant-balances"},"levels":3,"category":"","category_color":"","tags":["grant","details"]}}