{"title":"Manage balance accounts","category":"default","creationDate":1776961628,"content":"<p>A balance account is an API resource that contains information about the funds held by your user. To manage the balance accounts use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a>.<\/p>\n<p>This page contains instructions for common balance account operations. These operations are part of a larger process which includes <a href=\"\/pt\/issuing\/verification-overview\">verification<\/a> and <a href=\"\/pt\/issuing\/onboard-users\/onboarding-steps\">onboarding steps<\/a>.<\/p>\n<h2>Create a balance account<\/h2>\n<p>You can create balance accounts manually using the Configuration API. To create a balance account:<\/p>\n<ol>\n<li>\n<p>Make a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/post\/balanceAccounts\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balanceAccounts<\/a> request using the account holder ID you want to attach the balance account to.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Create a balance account'\" :id=\"'create-a-balance-account'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/bcl\\\/v2\\\/balanceAccounts \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST \\\\\\n-d '{\\n   \\&quot;accountHolderId\\&quot;: \\&quot;AH00000000000000000000001\\&quot;,\\n   \\&quot;description\\&quot;: \\&quot;AccountHolder Primary Balance Account\\&quot;\\n}'&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v33.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.balanceplatform.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.balancePlatform.*;\\n\\nClient client = new Client(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, Environment.TEST);\\n\\n\\\/\\\/ Create the request object(s)\\nBalanceAccountInfo balanceAccountInfo = new BalanceAccountInfo()\\n  .accountHolderId(\\&quot;AH00000000000000000000001\\&quot;)\\n  .description(\\&quot;AccountHolder Primary Balance Account\\&quot;);\\n\\n\\\/\\\/ Send the request\\nBalanceAccountsApi service = new BalanceAccountsApi(client);\\nBalanceAccount response = service.createBalanceAccount(balanceAccountInfo, null);&quot;},{&quot;language&quot;:&quot;php&quot;,&quot;tabTitle&quot;:&quot;PHP&quot;,&quot;content&quot;:&quot;&lt;?php\\n\\\/\\\/ Adyen PHP API Library v24.0.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Model\\\\BalancePlatform\\\\BalanceAccountInfo;\\nuse Adyen\\\\Service\\\\BalancePlatform\\\\BalanceAccountsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\n\\\/\\\/ Create the request object(s)\\n$balanceAccountInfo = new BalanceAccountInfo();\\n$balanceAccountInfo\\n  -&gt;setAccountHolderId(\\&quot;AH00000000000000000000001\\&quot;)\\n  -&gt;setDescription(\\&quot;AccountHolder Primary Balance Account\\&quot;);\\n\\n\\\/\\\/ Send the request\\n$service = new BalanceAccountsApi($client);\\n$response = $service-&gt;createBalanceAccount($balanceAccountInfo);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v28.0.0\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.BalancePlatform;\\nusing Adyen.Service.BalancePlatform;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Create the request object(s)\\nBalanceAccountInfo balanceAccountInfo = new BalanceAccountInfo\\n{\\n  AccountHolderId = \\&quot;AH00000000000000000000001\\&quot;,\\n  Description = \\&quot;AccountHolder Primary Balance Account\\&quot;\\n};\\n\\n\\\/\\\/ Send the request\\nvar service = new BalanceAccountsService(client);\\nvar response = service.CreateBalanceAccount(balanceAccountInfo);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nconst { Client, BalancePlatformAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst balanceAccountInfo = {\\n  accountHolderId: \\&quot;AH00000000000000000000001\\&quot;,\\n  description: \\&quot;AccountHolder Primary Balance Account\\&quot;\\n}\\n\\n\\\/\\\/ Send the request\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\nconst response = balancePlatformAPI.BalanceAccountsApi.createBalanceAccount(balanceAccountInfo);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v17.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/balancePlatform\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Create the request object(s)\\nbalanceAccountInfo := balancePlatform.BalanceAccountInfo{\\n  AccountHolderId: \\&quot;AH00000000000000000000001\\&quot;,\\n  Description: common.PtrString(\\&quot;AccountHolder Primary Balance Account\\&quot;),\\n}\\n\\n\\\/\\\/ Send the request\\nservice := client.BalancePlatform()\\nreq := service.BalanceAccountsApi.CreateBalanceAccountInput().BalanceAccountInfo(balanceAccountInfo)\\nres, httpRes, err := service.BalanceAccountsApi.CreateBalanceAccount(context.Background(), req)&quot;},{&quot;language&quot;:&quot;py&quot;,&quot;tabTitle&quot;:&quot;Python&quot;,&quot;content&quot;:&quot;# Adyen Python API Library v13.3.0\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\n# Create the request object(s)\\njson_request = {\\n  \\&quot;accountHolderId\\&quot;: \\&quot;AH00000000000000000000001\\&quot;,\\n  \\&quot;description\\&quot;: \\&quot;AccountHolder Primary Balance Account\\&quot;\\n}\\n\\n# Send the request\\nresult = adyen.balancePlatform.balance_accounts_api.create_balance_account(request=json_request)&quot;},{&quot;language&quot;:&quot;rb&quot;,&quot;tabTitle&quot;:&quot;Ruby&quot;,&quot;content&quot;:&quot;# Adyen Ruby API Library v10.1.1\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_BALANCE_PLATFORM_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nrequest_body = {\\n  :accountHolderId =&gt; 'AH00000000000000000000001',\\n  :description =&gt; 'AccountHolder Primary Balance Account'\\n}\\n\\n# Send the request\\nresult = adyen.balancePlatform.balance_accounts_api.create_balance_account(request_body)&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nimport { Client, BalancePlatformAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst balanceAccountInfo: Types.balancePlatform.BalanceAccountInfo = {\\n  accountHolderId: \\&quot;AH00000000000000000000001\\&quot;,\\n  description: \\&quot;AccountHolder Primary Balance Account\\&quot;\\n};\\n\\n\\\/\\\/ Send the request\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\nconst response = balancePlatformAPI.BalanceAccountsApi.createBalanceAccount(balanceAccountInfo);&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>id<\/code>. You need this ID to:<\/p>\n<ul>\n<li><a href=\"#view-balance-accounts\">View a balance account<\/a><\/li>\n<li><a href=\"#update-balance-account\">Update a balance account<\/a><\/li>\n<li><a href=\"#close-a-balance-account\">Close a balance account<\/a><\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Create balance account response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"accountHolderId\\\": \\\"AH00000000000000000000001\\\",\\n    \\\"defaultCurrencyCode\\\": \\\"EUR\\\",\\n    \\\"description\\\": \\\"Main Account\\\",\\n    \\\"reference\\\": \\\"Referee\\\",\\n    \\\"timeZone\\\": \\\"Europe\\\/Amsterdam\\\",\\n    \\\"balances\\\": [\\n        {\\n            \\\"available\\\": 0,\\n            \\\"balance\\\": 0,\\n            \\\"currency\\\": \\\"EUR\\\",\\n            \\\"pending\\\": 0,\\n            \\\"reserved\\\": 0\\n        }\\n    ],\\n    \\\"id\\\": \\\"BA00000000000000000000001\\\",\\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=\"view-balance-accounts\">View balance accounts<\/h2>\n<p>To view the balance accounts and the available balances of your account holder, you can either use your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> or make an API request.<\/p>\n\n<div id=\"tabKCDrk\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Customer Area&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To view balance accounts in your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n  &lt;li&gt;\\n&lt;p&gt;Select &lt;b&gt;Accounts &amp;amp; balances&lt;\\\/b&gt; &amp;gt; &lt;b&gt;Balance accounts&lt;\\\/b&gt;.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n  &lt;li&gt;\\n&lt;p&gt;In the &lt;b&gt;Balance platform&lt;\\\/b&gt; dropdown, select the balance platform. You can view balance accounts from one balance platform at a time.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n  &lt;li&gt;\\n&lt;p&gt;Select a &lt;b&gt;Balance account ID&lt;\\\/b&gt; to view more details, such as the available balances.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;Alternatively, enter a balance account ID in the &lt;strong&gt;Search&lt;\\\/strong&gt; menu to find a balance account.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:&quot;ca&quot;,&quot;oldTabId&quot;:&quot;ba-customer-area_1&quot;,&quot;relation&quot;:&quot;ca&quot;},{&quot;title&quot;:&quot;API&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To get balance accounts, use the following endpoints:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;GET &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/#\\\/balanceplatform\\\/latest\\\/get\\\/accountHolders\\\/{id}\\\/balanceAccounts\\&quot; class=\\&quot;codeLabel external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/accountHolders\\\/{id}\\\/balanceAccounts&lt;\\\/a&gt;: get a list of the balance accounts of an account holder. This endpoint returns a paginated list of balance accounts.&lt;\\\/li&gt;\\n&lt;li&gt;GET  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/get\\\/balanceAccounts\\\/(id)\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/balanceAccounts\\\/{id}&lt;\\\/a&gt;: get the details of a balance account, including a list of &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/#\\\/balanceplatform\\\/latest\\\/get\\\/balanceAccounts\\\/{id}__resParam_balances\\&quot; class=\\&quot;codeLabel external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balances&lt;\\\/a&gt; associated with the balance account.&lt;\\\/li&gt;\\n&lt;li&gt;GET  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/get\\\/balanceAccounts\\\/(id)\\\/paymentInstruments\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/balanceAccounts\\\/{id}\\\/paymentInstruments&lt;\\\/a&gt;: get a list of the payment instruments (cards) associated with the balance account.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&quot;,&quot;altTitle&quot;:&quot;api&quot;,&quot;oldTabId&quot;:&quot;ba-api_2&quot;,&quot;relation&quot;:&quot;api&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"update-balance-account\">Update a balance account<\/h2>\n<p>To update a balance account, make a PATCH <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/patch\/balanceAccounts\/{id}\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balanceAccounts\/{id}<\/a> request. The following example shows how to update the description of a balance account.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Change the description of a balance account'\" :id=\"'change-ba-description'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/bcl\\\/v2\\\/balanceAccounts\\\/BA00000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X PATCH \\\\\\n-d '{\\n    \\&quot;description\\&quot;:\\&quot;Balance account for new business\\&quot;\\n}'&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v33.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.balanceplatform.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.balancePlatform.*;\\n\\nClient client = new Client(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, Environment.TEST);\\n\\n\\\/\\\/ Create the request object(s)\\nBalanceAccountUpdateRequest balanceAccountUpdateRequest = new BalanceAccountUpdateRequest()\\n  .description(\\&quot;Balance account for new business\\&quot;);\\n\\n\\\/\\\/ Send the request\\nBalanceAccountsApi service = new BalanceAccountsApi(client);\\nBalanceAccount response = service.updateBalanceAccount(\\&quot;id\\&quot;, balanceAccountUpdateRequest, null);&quot;},{&quot;language&quot;:&quot;php&quot;,&quot;tabTitle&quot;:&quot;PHP&quot;,&quot;content&quot;:&quot;&lt;?php\\n\\\/\\\/ Adyen PHP API Library v24.0.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Model\\\\BalancePlatform\\\\BalanceAccountUpdateRequest;\\nuse Adyen\\\\Service\\\\BalancePlatform\\\\BalanceAccountsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\n\\\/\\\/ Create the request object(s)\\n$balanceAccountUpdateRequest = new BalanceAccountUpdateRequest();\\n$balanceAccountUpdateRequest\\n  -&gt;setDescription(\\&quot;Balance account for new business\\&quot;);\\n\\n\\\/\\\/ Send the request\\n$service = new BalanceAccountsApi($client);\\n$response = $service-&gt;updateBalanceAccount('id', $balanceAccountUpdateRequest);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v28.0.0\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.BalancePlatform;\\nusing Adyen.Service.BalancePlatform;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Create the request object(s)\\nBalanceAccountUpdateRequest balanceAccountUpdateRequest = new BalanceAccountUpdateRequest\\n{\\n  Description = \\&quot;Balance account for new business\\&quot;\\n};\\n\\n\\\/\\\/ Send the request\\nvar service = new BalanceAccountsService(client);\\nvar response = service.UpdateBalanceAccount(\\&quot;id\\&quot;, balanceAccountUpdateRequest);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nconst { Client, BalancePlatformAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst balanceAccountUpdateRequest = {\\n  description: \\&quot;Balance account for new business\\&quot;\\n}\\n\\n\\\/\\\/ Send the request\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\nconst response = balancePlatformAPI.BalanceAccountsApi.updateBalanceAccount(\\&quot;id\\&quot;, balanceAccountUpdateRequest);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v17.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v17\\\/src\\\/balancePlatform\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Create the request object(s)\\nbalanceAccountUpdateRequest := balancePlatform.BalanceAccountUpdateRequest{\\n  Description: common.PtrString(\\&quot;Balance account for new business\\&quot;),\\n}\\n\\n\\\/\\\/ Send the request\\nservice := client.BalancePlatform()\\nreq := service.BalanceAccountsApi.UpdateBalanceAccountInput(\\&quot;id\\&quot;).BalanceAccountUpdateRequest(balanceAccountUpdateRequest)\\nres, httpRes, err := service.BalanceAccountsApi.UpdateBalanceAccount(context.Background(), req)&quot;},{&quot;language&quot;:&quot;py&quot;,&quot;tabTitle&quot;:&quot;Python&quot;,&quot;content&quot;:&quot;# Adyen Python API Library v13.3.0\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\n# Create the request object(s)\\njson_request = {\\n  \\&quot;description\\&quot;: \\&quot;Balance account for new business\\&quot;\\n}\\n\\n# Send the request\\nresult = adyen.balancePlatform.balance_accounts_api.update_balance_account(request=json_request, id=\\&quot;id\\&quot;)&quot;},{&quot;language&quot;:&quot;rb&quot;,&quot;tabTitle&quot;:&quot;Ruby&quot;,&quot;content&quot;:&quot;# Adyen Ruby API Library v10.1.1\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_BALANCE_PLATFORM_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nrequest_body = {\\n  :description =&gt; 'Balance account for new business'\\n}\\n\\n# Send the request\\nresult = adyen.balancePlatform.balance_accounts_api.update_balance_account(request_body, 'id')&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v23.3.0\\nimport { Client, BalancePlatformAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst balanceAccountUpdateRequest: Types.balancePlatform.BalanceAccountUpdateRequest = {\\n  description: \\&quot;Balance account for new business\\&quot;\\n};\\n\\n\\\/\\\/ Send the request\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\nconst response = balancePlatformAPI.BalanceAccountsApi.updateBalanceAccount(\\&quot;id\\&quot;, balanceAccountUpdateRequest);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>Close a balance account<\/h2>\n<p>In some scenarios, you might want to close an account holder's balance account. For example, an account holder that has separate balance accounts for their businesses might want to close one of their businesses.<\/p>\n<p>To permanently close a balance account:<\/p>\n<ol>\n<li>Check if the balance account has <a href=\"#view-balance-accounts\">zero balance<\/a>. You can only close empty balance accounts, so if there are funds left, <a href=\"\/pt\/issuing\/add-manage-funds\">transfer<\/a> any remaining balance..<\/li>\n<li>Close a balance account by <a href=\"#update-balance-account\">updating the balance account<\/a> and setting the <code>status<\/code> to <strong>Closed<\/strong>.<\/li>\n<\/ol>\n<p>If an account holder discontinues their contractual relationship with your platform, you can also <a href=\"\/pt\/issuing\/manage-account-holders#permanent-deactivation\">permanently deactivate the account holder<\/a>.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/issuing\/manage-balance-accounts","articleFields":{"description":"View and manage the balance accounts in your platform.","cache_enable":false,"parameters":{"directoryPath":"\/issuing","model":"issuing","integrationType":"issuing"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/issuing\/manage-balance-accounts","title":"Manage balance accounts","content":"A balance account is an API resource that contains information about the funds held by your user. To manage the balance accounts use the  Configuration API.\nThis page contains instructions for common balance account operations. These operations are part of a larger process which includes verification and onboarding steps.\nCreate a balance account\nYou can create balance accounts manually using the Configuration API. To create a balance account:\n\n\nMake a POST  \/balanceAccounts request using the account holder ID you want to attach the balance account to.\n\n\n\n\n\nIn the response, note the id. You need this ID to:\n\nView a balance account\nUpdate a balance account\nClose a balance account\n\n\n\n\n\n\nView balance accounts\nTo view the balance accounts and the available balances of your account holder, you can either use your Customer Area or make an API request.\n\n\n    \n        \n        \n    \n\n\nUpdate a balance account\nTo update a balance account, make a PATCH \/balanceAccounts\/{id} request. The following example shows how to update the description of a balance account.\n\n    \n\nClose a balance account\nIn some scenarios, you might want to close an account holder's balance account. For example, an account holder that has separate balance accounts for their businesses might want to close one of their businesses.\nTo permanently close a balance account:\n\nCheck if the balance account has zero balance. You can only close empty balance accounts, so if there are funds left, transfer any remaining balance..\nClose a balance account by updating the balance account and setting the status to Closed.\n\nIf an account holder discontinues their contractual relationship with your platform, you can also permanently deactivate the account holder.","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Issuing","lvl2":"Manage balance accounts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/issuing","lvl2":"\/pt\/issuing\/manage-balance-accounts"},"levels":3,"category":"Issuing","category_color":"green","tags":["Manage","balance","accounts"]}}
