{"title":"Create business accounts","category":"default","creationDate":1704386220,"content":"<p>When you create an Adyen business account for your users, you generate a business account number linked to their balance account. Your users can share their business account number with third parties so they can receive business-related payments or fund transfers.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you can create business accounts for your users, check if you meet the <a href=\"\/pt\/business-accounts#requirements\">requirements for business accounts<\/a>.<\/p>\n<p>Additionally, make sure that your users have:<\/p>\n<ul>\n<li><a href=\"\/pt\/business-accounts\/manage-legal-entities\">Legal entities<\/a> for both your user and all entities associated with the user. For example, the ultimate beneficial owners (UBOs) for an organization.<\/li>\n<li>Business lines, which contain information about your user's line of business. You need to create two business lines, one for your user to receive payments and one for business accounts.<\/li>\n<li>An <a href=\"\/pt\/business-accounts\/manage-account-holders\">account holder<\/a> and a <a href=\"\/pt\/business-accounts\/manage-balance-accounts\">balance account<\/a>.<\/li>\n<li>Completed the <a href=\"\/pt\/business-accounts\/verification-requirements\">verification checks for business accounts<\/a> and have the <strong>issueBankAccount<\/strong> <a href=\"\/pt\/business-accounts\/verification-overview\/capabilities\">capability<\/a> allowed and enabled.<\/li>\n<\/ul>\n<h2>Create a payment instrument<\/h2>\n<p>After the <strong>issueBankAccount<\/strong> capability has been allowed and enabled on the account holder of your user, you can proceed with creating a payment instrument for them. Payment instruments\u2014such as business accounts\u2014are resources that account holders can use externally to transact with their balance account. Creating a business account payment instrument generates a business account number, such as an IBAN.<\/p>\n<p>To create a business account payment instrument, make a POST <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/post\/paymentInstruments\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/paymentInstruments<\/a> call specifying:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter name<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/post\/paymentInstruments#request-balanceAccountId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balanceAccountId<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The ID returned when you created the balance account. All financial transactions, such as receiving and sending funds, will be processed in this balance account.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/post\/paymentInstruments__reqParam_issuingCountryCode\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">issuingCountryCode<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The two-letter country code where the business account is issued from. We currently support <strong>NL<\/strong> and <strong>US<\/strong>.<br><br>The currency of the specified country must match the currency of the balance account.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/post\/paymentInstruments#request-type\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">type<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <strong>bankAccount<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/post\/paymentInstruments#request-description\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">description<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>Your description for the business account, which you can use to store useful information for your staff.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/post\/paymentInstruments__reqParam_reference\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">reference<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>Your reference for the business account, which you can map to your internal systems.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><div class=\"sc-notice note\"><div> A balance account can only have one business account number. The API returns an error if a business account number already exists.<\/div><\/div><\/p>\n\n<div id=\"tab9yNPm\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;IBAN&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Here is how you create an IBAN for a business account issued in the Netherlands.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Create an IBAN&#039;\\&quot; :id=\\&quot;&#039;create-business-account-request&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;curl&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl https:\\\\\\\/\\\\\\\/balanceplatform-api-test.adyen.com\\\\\\\/bcl\\\\\\\/v2\\\\\\\/paymentInstruments \\\\\\\\\\\\n-H &#039;x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY&#039; \\\\\\\\\\\\n-H &#039;content-type: application\\\\\\\/json&#039; \\\\\\\\\\\\n-X POST  \\\\\\\\\\\\n-d &#039;{\\\\n    \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n    \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;{hint:Your human-readable description for the business account}S.Hopper - Account in NL{\\\\\\\/hint}\\\\&amp;quot;,\\\\n    \\\\&amp;quot;balanceAccountId\\\\&amp;quot;: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n    \\\\&amp;quot;issuingCountryCode\\\\&amp;quot;: \\\\&amp;quot;NL\\\\&amp;quot;\\\\n}&#039;&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;java&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Java&amp;quot;,&amp;quot;content&amp;quot;:&amp;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(\\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, Environment.TEST);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPaymentInstrumentInfo paymentInstrumentInfo = new PaymentInstrumentInfo()\\\\n  .balanceAccountId(\\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;)\\\\n  .description(\\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;)\\\\n  .type(PaymentInstrumentInfo.TypeEnum.BANKACCOUNT)\\\\n  .issuingCountryCode(\\\\&amp;quot;NL\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nPaymentInstrumentsApi service = new PaymentInstrumentsApi(client);\\\\nPaymentInstrument response = service.createPaymentInstrument(paymentInstrumentInfo, null);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;php&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;PHP&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;&amp;lt;?php\\\\n\\\\\\\/\\\\\\\/ Adyen PHP API Library v24.0.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\PaymentInstrumentInfo;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\BalancePlatform\\\\\\\\PaymentInstrumentsApi;\\\\n\\\\n$client = new Client();\\\\n$client-&amp;gt;setXApiKey(\\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;);\\\\n$client-&amp;gt;setEnvironment(Environment::TEST);\\\\n\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\n$paymentInstrumentInfo = new PaymentInstrumentInfo();\\\\n$paymentInstrumentInfo\\\\n  -&amp;gt;setBalanceAccountId(\\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;)\\\\n  -&amp;gt;setDescription(\\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;)\\\\n  -&amp;gt;setType(\\\\&amp;quot;bankAccount\\\\&amp;quot;)\\\\n  -&amp;gt;setIssuingCountryCode(\\\\&amp;quot;NL\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new PaymentInstrumentsApi($client);\\\\n$response = $service-&amp;gt;createPaymentInstrument($paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;cs&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;C#&amp;quot;,&amp;quot;content&amp;quot;:&amp;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 = \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n    Environment = Environment.Test\\\\n};\\\\nvar client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPaymentInstrumentInfo paymentInstrumentInfo = new PaymentInstrumentInfo\\\\n{\\\\n  BalanceAccountId = \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  Description = \\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;,\\\\n  Type = PaymentInstrumentInfo.TypeEnum.BankAccount,\\\\n  IssuingCountryCode = \\\\&amp;quot;NL\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new PaymentInstrumentsService(client);\\\\nvar response = service.CreatePaymentInstrument(paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;js&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (JavaScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nconst { Client, BalancePlatformAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst paymentInstrumentInfo = {\\\\n  type: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  description: \\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;,\\\\n  balanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  issuingCountryCode: \\\\&amp;quot;NL\\\\&amp;quot;\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PaymentInstrumentsApi.createPaymentInstrument(paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;go&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Go&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Go API Library v17.0.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/balancePlatform\\\\&amp;quot;\\\\n)\\\\nclient := adyen.NewClient(&amp;amp;common.Config{\\\\n  ApiKey:      \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  Environment: common.TestEnv,\\\\n})\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\npaymentInstrumentInfo := balancePlatform.PaymentInstrumentInfo{\\\\n  BalanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  Description: common.PtrString(\\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;),\\\\n  Type: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  IssuingCountryCode: \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.BalancePlatform()\\\\nreq := service.PaymentInstrumentsApi.CreatePaymentInstrumentInput().PaymentInstrumentInfo(paymentInstrumentInfo)\\\\nres, httpRes, err := service.PaymentInstrumentsApi.CreatePaymentInstrument(context.Background(), req)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;py&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Python&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Python API Library v13.3.0\\\\nimport Adyen\\\\n\\\\nadyen = Adyen.Adyen()\\\\nadyen.client.xapikey = \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;\\\\nadyen.client.platform = \\\\&amp;quot;test\\\\&amp;quot; # The environment to use library in.\\\\n\\\\n# Create the request object(s)\\\\njson_request = {\\\\n  \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;,\\\\n  \\\\&amp;quot;balanceAccountId\\\\&amp;quot;: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  \\\\&amp;quot;issuingCountryCode\\\\&amp;quot;: \\\\&amp;quot;NL\\\\&amp;quot;\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.payment_instruments_api.create_payment_instrument(request=json_request)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;rb&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Ruby&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Ruby API Library v10.1.1\\\\nrequire \\\\&amp;quot;adyen-ruby-api-library\\\\&amp;quot;\\\\n\\\\nadyen = Adyen::Client.new\\\\nadyen.api_key = &#039;ADYEN_BALANCE_PLATFORM_API_KEY&#039;\\\\nadyen.env = :test # Set to \\\\&amp;quot;live\\\\&amp;quot; for live environment\\\\n\\\\n# Create the request object(s)\\\\nrequest_body = {\\\\n  :type =&amp;gt; &#039;bankAccount&#039;,\\\\n  :description =&amp;gt; &#039;S.Hopper - Account in NL&#039;,\\\\n  :balanceAccountId =&amp;gt; &#039;BA00000000000000000000001&#039;,\\\\n  :issuingCountryCode =&amp;gt; &#039;NL&#039;\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.payment_instruments_api.create_payment_instrument(request_body)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;ts&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (TypeScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nimport { Client, BalancePlatformAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst paymentInstrumentInfo: Types.balancePlatform.PaymentInstrumentInfo = {\\\\n  balanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  description: \\\\&amp;quot;S.Hopper - Account in NL\\\\&amp;quot;,\\\\n  type: Types.balancePlatform.PaymentInstrumentInfo.TypeEnum.BankAccount,\\\\n  issuingCountryCode: \\\\&amp;quot;NL\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PaymentInstrumentsApi.createPaymentInstrument(paymentInstrumentInfo);&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;The response returns the &lt;strong&gt;paymentInstrument&lt;\\\/strong&gt; resource, identified by its unique &lt;code&gt;id&lt;\\\/code&gt;. You also receive the &lt;code&gt;iban&lt;\\\/code&gt; which the account holder can use when sending funds to their business account.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Response&#039;\\&quot; :id=\\&quot;&#039;create-business-account-response&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;balanceAccountId\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n    \\\\\\&quot;issuingCountryCode\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n    \\\\\\&quot;status\\\\\\&quot;: \\\\\\&quot;Active\\\\\\&quot;,\\\\n    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;bankAccount\\\\\\&quot;,\\\\n    \\\\\\&quot;bankAccount\\\\\\&quot;: {\\\\n      \\\\\\&quot;iban\\\\\\&quot;: \\\\\\&quot;NL20ADYB2017000035\\\\\\&quot;\\\\n    },\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;PI322LJ223222B5DJS7CD9LWL\\\\\\&quot;\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;iban_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;US account number&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;Here is how you create an account number for a business account issued in the US.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Create a US account number&#039;\\&quot; :id=\\&quot;&#039;create-us-business-account&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;curl&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl https:\\\\\\\/\\\\\\\/balanceplatform-api-test.adyen.com\\\\\\\/bcl\\\\\\\/v2\\\\\\\/paymentInstruments \\\\\\\\\\\\n-H &#039;x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY&#039; \\\\\\\\\\\\n-H &#039;content-type: application\\\\\\\/json&#039; \\\\\\\\\\\\n-X POST  \\\\\\\\\\\\n-d &#039;{\\\\n    \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n    \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;{hint:Your human-readable description for the business account}S.Hopper - Account in the US{\\\\\\\/hint}\\\\&amp;quot;,\\\\n    \\\\&amp;quot;balanceAccountId\\\\&amp;quot;: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n    \\\\&amp;quot;issuingCountryCode\\\\&amp;quot;: \\\\&amp;quot;US\\\\&amp;quot;\\\\n}&#039;&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;java&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Java&amp;quot;,&amp;quot;content&amp;quot;:&amp;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(\\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, Environment.TEST);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPaymentInstrumentInfo paymentInstrumentInfo = new PaymentInstrumentInfo()\\\\n  .balanceAccountId(\\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;)\\\\n  .description(\\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;)\\\\n  .type(PaymentInstrumentInfo.TypeEnum.BANKACCOUNT)\\\\n  .issuingCountryCode(\\\\&amp;quot;US\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nPaymentInstrumentsApi service = new PaymentInstrumentsApi(client);\\\\nPaymentInstrument response = service.createPaymentInstrument(paymentInstrumentInfo, null);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;php&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;PHP&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;&amp;lt;?php\\\\n\\\\\\\/\\\\\\\/ Adyen PHP API Library v24.0.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\PaymentInstrumentInfo;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\BalancePlatform\\\\\\\\PaymentInstrumentsApi;\\\\n\\\\n$client = new Client();\\\\n$client-&amp;gt;setXApiKey(\\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;);\\\\n$client-&amp;gt;setEnvironment(Environment::TEST);\\\\n\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\n$paymentInstrumentInfo = new PaymentInstrumentInfo();\\\\n$paymentInstrumentInfo\\\\n  -&amp;gt;setBalanceAccountId(\\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;)\\\\n  -&amp;gt;setDescription(\\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;)\\\\n  -&amp;gt;setType(\\\\&amp;quot;bankAccount\\\\&amp;quot;)\\\\n  -&amp;gt;setIssuingCountryCode(\\\\&amp;quot;US\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new PaymentInstrumentsApi($client);\\\\n$response = $service-&amp;gt;createPaymentInstrument($paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;cs&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;C#&amp;quot;,&amp;quot;content&amp;quot;:&amp;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 = \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n    Environment = Environment.Test\\\\n};\\\\nvar client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nPaymentInstrumentInfo paymentInstrumentInfo = new PaymentInstrumentInfo\\\\n{\\\\n  BalanceAccountId = \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  Description = \\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;,\\\\n  Type = PaymentInstrumentInfo.TypeEnum.BankAccount,\\\\n  IssuingCountryCode = \\\\&amp;quot;US\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new PaymentInstrumentsService(client);\\\\nvar response = service.CreatePaymentInstrument(paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;js&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (JavaScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nconst { Client, BalancePlatformAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst paymentInstrumentInfo = {\\\\n  type: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  description: \\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;,\\\\n  balanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  issuingCountryCode: \\\\&amp;quot;US\\\\&amp;quot;\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PaymentInstrumentsApi.createPaymentInstrument(paymentInstrumentInfo);&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;go&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Go&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Go API Library v17.0.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v17\\\\\\\/src\\\\\\\/balancePlatform\\\\&amp;quot;\\\\n)\\\\nclient := adyen.NewClient(&amp;amp;common.Config{\\\\n  ApiKey:      \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  Environment: common.TestEnv,\\\\n})\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\npaymentInstrumentInfo := balancePlatform.PaymentInstrumentInfo{\\\\n  BalanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  Description: common.PtrString(\\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;),\\\\n  Type: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  IssuingCountryCode: \\\\&amp;quot;US\\\\&amp;quot;,\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.BalancePlatform()\\\\nreq := service.PaymentInstrumentsApi.CreatePaymentInstrumentInput().PaymentInstrumentInfo(paymentInstrumentInfo)\\\\nres, httpRes, err := service.PaymentInstrumentsApi.CreatePaymentInstrument(context.Background(), req)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;py&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Python&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Python API Library v13.3.0\\\\nimport Adyen\\\\n\\\\nadyen = Adyen.Adyen()\\\\nadyen.client.xapikey = \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;\\\\nadyen.client.platform = \\\\&amp;quot;test\\\\&amp;quot; # The environment to use library in.\\\\n\\\\n# Create the request object(s)\\\\njson_request = {\\\\n  \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;bankAccount\\\\&amp;quot;,\\\\n  \\\\&amp;quot;description\\\\&amp;quot;: \\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;,\\\\n  \\\\&amp;quot;balanceAccountId\\\\&amp;quot;: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  \\\\&amp;quot;issuingCountryCode\\\\&amp;quot;: \\\\&amp;quot;US\\\\&amp;quot;\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.payment_instruments_api.create_payment_instrument(request=json_request)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;rb&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;Ruby&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;# Adyen Ruby API Library v10.1.1\\\\nrequire \\\\&amp;quot;adyen-ruby-api-library\\\\&amp;quot;\\\\n\\\\nadyen = Adyen::Client.new\\\\nadyen.api_key = &#039;ADYEN_BALANCE_PLATFORM_API_KEY&#039;\\\\nadyen.env = :test # Set to \\\\&amp;quot;live\\\\&amp;quot; for live environment\\\\n\\\\n# Create the request object(s)\\\\nrequest_body = {\\\\n  :type =&amp;gt; &#039;bankAccount&#039;,\\\\n  :description =&amp;gt; &#039;S.Hopper - Account in the US&#039;,\\\\n  :balanceAccountId =&amp;gt; &#039;BA00000000000000000000001&#039;,\\\\n  :issuingCountryCode =&amp;gt; &#039;US&#039;\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.payment_instruments_api.create_payment_instrument(request_body)&amp;quot;},{&amp;quot;language&amp;quot;:&amp;quot;ts&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;NodeJS (TypeScript)&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;\\\\\\\/\\\\\\\/ Adyen Node API Library v23.3.0\\\\nimport { Client, BalancePlatformAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\nconst client = new Client({ apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;, environment: \\\\&amp;quot;TEST\\\\&amp;quot; });\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst paymentInstrumentInfo: Types.balancePlatform.PaymentInstrumentInfo = {\\\\n  balanceAccountId: \\\\&amp;quot;BA00000000000000000000001\\\\&amp;quot;,\\\\n  description: \\\\&amp;quot;S.Hopper - Account in the US\\\\&amp;quot;,\\\\n  type: Types.balancePlatform.PaymentInstrumentInfo.TypeEnum.BankAccount,\\\\n  issuingCountryCode: \\\\&amp;quot;US\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.PaymentInstrumentsApi.createPaymentInstrument(paymentInstrumentInfo);&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;The response returns the &lt;strong&gt;paymentInstrument&lt;\\\/strong&gt; resource, identified by its unique &lt;code&gt;id&lt;\\\/code&gt;. You also receive the &lt;code&gt;bankAccount&lt;\\\/code&gt; details that the account holder can use when sending funds to their business account.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Response&#039;\\&quot; :id=\\&quot;&#039;create-business-account-response&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;balanceAccountId\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n    \\\\\\&quot;issuingCountryCode\\\\\\&quot;: \\\\\\&quot;US\\\\\\&quot;,\\\\n    \\\\\\&quot;status\\\\\\&quot;: \\\\\\&quot;Active\\\\\\&quot;,\\\\n    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;bankAccount\\\\\\&quot;,\\\\n    \\\\\\&quot;bankAccount\\\\\\&quot;: {\\\\n        \\\\\\&quot;accountNumber\\\\\\&quot;: \\\\\\&quot;333720756\\\\\\&quot;,\\\\n        \\\\\\&quot;routingNumber\\\\\\&quot;: \\\\\\&quot;21000021\\\\\\&quot;,\\\\n        \\\\\\&quot;accountType\\\\\\&quot;: \\\\\\&quot;checking\\\\\\&quot;\\\\n \\\\t},\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;PI322LJ223222B5DJS7CD9LWL\\\\\\&quot;\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;us_account_number_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>Get payment instruments<\/h2>\n<p>To find the existing business account number related to a specified balance account, make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/balanceAccounts\/(id)\/paymentInstruments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balanceAccounts\/{id}\/paymentInstruments<\/a> request and specify the balance account <code>id<\/code> in the path.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/create-business-accounts","articleFields":{"description":"Create and manage business accounts for your users.","feedback_component":true,"filters_component":false,"decision_tree":"[]","page_id":"d3590daa-8108-4943-8361-d18e3050baec","last_edit_on":"04-01-2024 17:37","parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/create-business-accounts","title":"Create business accounts","content":"When you create an Adyen business account for your users, you generate a business account number linked to their balance account. Your users can share their business account number with third parties so they can receive business-related payments or fund transfers.\nRequirements\nBefore you can create business accounts for your users, check if you meet the requirements for business accounts.\nAdditionally, make sure that your users have:\n\nLegal entities for both your user and all entities associated with the user. For example, the ultimate beneficial owners (UBOs) for an organization.\nBusiness lines, which contain information about your user's line of business. You need to create two business lines, one for your user to receive payments and one for business accounts.\nAn account holder and a balance account.\nCompleted the verification checks for business accounts and have the issueBankAccount capability allowed and enabled.\n\nCreate a payment instrument\nAfter the issueBankAccount capability has been allowed and enabled on the account holder of your user, you can proceed with creating a payment instrument for them. Payment instruments\u2014such as business accounts\u2014are resources that account holders can use externally to transact with their balance account. Creating a business account payment instrument generates a business account number, such as an IBAN.\nTo create a business account payment instrument, make a POST \/paymentInstruments call specifying:\n\n\n\nParameter name\nRequired\nDescription\n\n\n\n\n balanceAccountId\n\nThe ID returned when you created the balance account. All financial transactions, such as receiving and sending funds, will be processed in this balance account.\n\n\nissuingCountryCode\n\nThe two-letter country code where the business account is issued from. We currently support NL and US.The currency of the specified country must match the currency of the balance account.\n\n\n type\n\nSet to bankAccount.\n\n\n description\n\nYour description for the business account, which you can use to store useful information for your staff.\n\n\nreference\n\nYour reference for the business account, which you can map to your internal systems.\n\n\n\n A balance account can only have one business account number. The API returns an error if a business account number already exists.\n\n\n    \n        \n        \n    \n\n\nGet payment instruments\nTo find the existing business account number related to a specified balance account, make a GET  \/balanceAccounts\/{id}\/paymentInstruments request and specify the balance account id in the path.","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Create business accounts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"\/pt\/business-accounts\/create-business-accounts"},"levels":3,"category":"","category_color":"","tags":["Create","business","accounts"]}}
