{"title":"Transfer routes","category":"default","creationDate":1678746720,"content":"<p>Sending funds to transfer instruments can have additional requirements or limitations. For example, the bank that holds your user's transfer instrument may only support specific transfer priorities, or limit the amount of funds that you can send. These requirements or limitations are set by the bank or its regulating entities.<\/p>\n<p>To prevent transfer failures due to such limitations, we recommend that you calculate the available transfer routes before sending funds to a new recipient.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, consider the following requirements:<\/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 <a href=\"\/pt\/adyen-for-platforms-model\">Adyen for Platforms<\/a> integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/api-credentials\/roles\/\">API credential roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Your API credential for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a> must have the following role: <ul><li markdown=\"1\"><strong>Balance Platform BCL role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Calculate transfer routes<\/h2>\n<p>You can make calculate all available transfer routes for either a specific location or a set of counterparty bank details. The following tabs explain both of these methods.<\/p>\n\n<div id=\"tabhWKAr\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Calculate routes by country\\\/region&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To calculate transfer routes for a specific country\\\/region:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;\\n&lt;p&gt;Make a POST  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transferRoutes\\\/calculate&lt;\\\/a&gt; request. Provide the following parameters in the request body:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter&lt;\\\/th&gt;\\n&lt;th style=\\&quot;text-align: center;\\&quot;&gt;Required&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-balancePlatform\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balancePlatform&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The unique identifier of your balance platform.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-currency\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;currency&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The three-character ISO currency code of the transfer.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-category\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;category&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The type of transfer. Set to &lt;strong&gt;bank&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-country\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;country&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The two-character ISO country code of the counterparty. For example, &lt;strong&gt;US&lt;\\\/strong&gt; or &lt;strong&gt;NL&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-priorities\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;priorities&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;\\\/td&gt;\\n&lt;td&gt;An array that contains the priorities that you want to calculate transfer routes for. For example: &lt;strong&gt;regular&lt;\\\/strong&gt;, &lt;strong&gt;fast&lt;\\\/strong&gt;, &lt;strong&gt;wire&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;p&gt;The following example shows how to make a request to calculate transfer routes for a counterparty in the Netherlands.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Example request\\u2014Calculate the available transfer routes by country\\\/region&#039;\\&quot; :id=\\&quot;&#039;calculate-transfer-routes&#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\\\\\\\/transferRoutes\\\\\\\/calculate \\\\\\\\\\\\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;balancePlatform\\\\&amp;quot;: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n    \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n    \\\\&amp;quot;category\\\\&amp;quot;: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n    \\\\&amp;quot;country\\\\&amp;quot;: \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n    \\\\&amp;quot;priorities\\\\&amp;quot;: [\\\\n        \\\\&amp;quot;regular\\\\&amp;quot;,\\\\n        \\\\&amp;quot;crossBorder\\\\&amp;quot;,\\\\n        \\\\&amp;quot;wire\\\\&amp;quot;\\\\n    ]\\\\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 v40.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)\\\\nTransferRouteRequest transferRouteRequest = new TransferRouteRequest()\\\\n  .country(\\\\&amp;quot;NL\\\\&amp;quot;)\\\\n  .priorities(Arrays.asList(TransferRouteRequest.PrioritiesEnum.REGULAR,\\\\nTransferRouteRequest.PrioritiesEnum.CROSSBORDER,\\\\nTransferRouteRequest.PrioritiesEnum.WIRE))\\\\n  .currency(\\\\&amp;quot;USD\\\\&amp;quot;)\\\\n  .category(TransferRouteRequest.CategoryEnum.BANK)\\\\n  .balancePlatform(\\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nTransferRoutesApi service = new TransferRoutesApi(client);\\\\nTransferRouteResponse response = service.calculateTransferRoutes(transferRouteRequest, 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 v28.3.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\TransferRouteRequest;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\BalancePlatform\\\\\\\\TransferRoutesApi;\\\\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$transferRouteRequest = new TransferRouteRequest();\\\\n$transferRouteRequest\\\\n  -&amp;gt;setCountry(\\\\&amp;quot;NL\\\\&amp;quot;)\\\\n  -&amp;gt;setPriorities(array(\\\\&amp;quot;regular\\\\&amp;quot;, \\\\&amp;quot;crossBorder\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot;))\\\\n  -&amp;gt;setCurrency(\\\\&amp;quot;USD\\\\&amp;quot;)\\\\n  -&amp;gt;setCategory(\\\\&amp;quot;bank\\\\&amp;quot;)\\\\n  -&amp;gt;setBalancePlatform(\\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new TransferRoutesApi($client);\\\\n$response = $service-&amp;gt;calculateTransferRoutes($transferRouteRequest);&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 v32.2.1\\\\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)\\\\nTransferRouteRequest transferRouteRequest = new TransferRouteRequest\\\\n{\\\\n  Country = \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n  Priorities = { TransferRouteRequest.PrioritiesEnum.Regular,\\\\n    TransferRouteRequest.PrioritiesEnum.CrossBorder,\\\\n    TransferRouteRequest.PrioritiesEnum.Wire },\\\\n  Currency = \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n  Category = TransferRouteRequest.CategoryEnum.Bank,\\\\n  BalancePlatform = \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new TransferRoutesService(client);\\\\nvar response = service.CalculateTransferRoutes(transferRouteRequest);&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 v30.0.1\\\\nconst { Client, BalancePlatformAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\nconst config = new Config({\\\\n  apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  environment: EnvironmentEnum.TEST\\\\n});\\\\n\\\\nconst client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst transferRouteRequest = {\\\\n  balancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n  currency: \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n  category: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  country: \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n  priorities: [ \\\\&amp;quot;regular\\\\&amp;quot;, \\\\&amp;quot;crossBorder\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot; ]\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.TransferRoutesApi.calculateTransferRoutes(transferRouteRequest);&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 v21.1.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/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)\\\\ntransferRouteRequest := balancePlatform.TransferRouteRequest{\\\\n  Country: common.PtrString(\\\\&amp;quot;NL\\\\&amp;quot;),\\\\n  Priorities: []string{\\\\n    \\\\&amp;quot;regular\\\\&amp;quot;, \\\\&amp;quot;crossBorder\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot;,\\\\n  },\\\\n  Currency: \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n  Category: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  BalancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.BalancePlatform()\\\\nreq := service.TransferRoutesApi.CalculateTransferRoutesInput().TransferRouteRequest(transferRouteRequest)\\\\nres, httpRes, err := service.TransferRoutesApi.CalculateTransferRoutes(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 v14.0.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;balancePlatform\\\\&amp;quot;: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n  \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n  \\\\&amp;quot;category\\\\&amp;quot;: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  \\\\&amp;quot;country\\\\&amp;quot;: \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n  \\\\&amp;quot;priorities\\\\&amp;quot;: [ \\\\&amp;quot;regular\\\\&amp;quot;, \\\\&amp;quot;crossBorder\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot; ]\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.transfer_routes_api.calculate_transfer_routes(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 v11.1.0\\\\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  :balancePlatform =&amp;gt; &#039;YOUR_BALANCE_PLATFORM&#039;,\\\\n  :currency =&amp;gt; &#039;USD&#039;,\\\\n  :category =&amp;gt; &#039;bank&#039;,\\\\n  :country =&amp;gt; &#039;NL&#039;,\\\\n  :priorities =&amp;gt; [ &#039;regular&#039;, &#039;crossBorder&#039;, &#039;wire&#039; ]\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.transfer_routes_api.calculate_transfer_routes(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 v30.0.1\\\\nimport { Client, BalancePlatformAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\nconst config = new Config({\\\\n  apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  environment: EnvironmentEnum.TEST\\\\n});\\\\n\\\\nconst client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst transferRouteRequest: Types.balancePlatform.TransferRouteRequest = {\\\\n  country: \\\\&amp;quot;NL\\\\&amp;quot;,\\\\n  priorities: [\\\\n    Types.balancePlatform.TransferRouteRequest.PrioritiesEnum.Regular,\\\\n    Types.balancePlatform.TransferRouteRequest.PrioritiesEnum.CrossBorder,\\\\n    Types.balancePlatform.TransferRouteRequest.PrioritiesEnum.Wire\\\\n  ],\\\\n  currency: \\\\&amp;quot;USD\\\\&amp;quot;,\\\\n  category: Types.balancePlatform.TransferRouteRequest.CategoryEnum.Bank,\\\\n  balancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.TransferRoutesApi.calculateTransferRoutes(transferRouteRequest);&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;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;In the response, note the &lt;code&gt;transferRoutes&lt;\\\/code&gt; object, which includes all transfer routes supported in a country\\\/region. Each transfer route specifies:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;The supported currency.&lt;\\\/li&gt;\\n&lt;li&gt;The supported priority.&lt;\\\/li&gt;\\n&lt;li&gt;Any additional requirements you must fulfill when using the transfer route.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Example response\\u2014Transfer routes by country\\\/region&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;transferRoutes\\\\\\&quot;: [\\\\n        {\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;USD\\\\\\&quot;,\\\\n            \\\\\\&quot;priority\\\\\\&quot;: \\\\\\&quot;regular\\\\\\&quot;,\\\\n            \\\\\\&quot;requirements\\\\\\&quot;: []\\\\n        },\\\\n        {\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;USD\\\\\\&quot;,\\\\n            \\\\\\&quot;priority\\\\\\&quot;: \\\\\\&quot;crossBorder\\\\\\&quot;,\\\\n            \\\\\\&quot;requirements\\\\\\&quot;: [\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Amount of transfer must be at least 100, and no greater than 99999999999\\\\\\&quot;,\\\\n                    \\\\\\&quot;max\\\\\\&quot;: 99999999999,\\\\n                    \\\\\\&quot;min\\\\\\&quot;: 100,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;amountMinMaxRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Country, street and city is required.\\\\\\&quot;,\\\\n                    \\\\\\&quot;requiredAddressFields\\\\\\&quot;: [\\\\n                        \\\\\\&quot;STREET\\\\\\&quot;,\\\\n                        \\\\\\&quot;CITY\\\\\\&quot;\\\\n                    ],\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;addressRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Bank account identification type must be iban or numberAndBic\\\\\\&quot;,\\\\n                    \\\\\\&quot;bankAccountIdentificationTypes\\\\\\&quot;: [\\\\n                        \\\\\\&quot;iban\\\\\\&quot;,\\\\n                        \\\\\\&quot;numberAndBic\\\\\\&quot;\\\\n                    ],\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;bankAccountIdentificationTypeRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;issuingCountryCode\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n                    \\\\\\&quot;paymentInstrumentType\\\\\\&quot;: \\\\\\&quot;BankAccount\\\\\\&quot;,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;paymentInstrumentRequirement\\\\\\&quot;\\\\n                }\\\\n            ]\\\\n        },\\\\n        {\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;USD\\\\\\&quot;,\\\\n            \\\\\\&quot;priority\\\\\\&quot;: \\\\\\&quot;wire\\\\\\&quot;,\\\\n            \\\\\\&quot;requirements\\\\\\&quot;: []\\\\n        }\\\\n    ]\\\\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&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;calculate_routes_by_countryregion_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Calculate transfer routes by counterparty&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To calculate transfer routes for a specific counterparty:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;\\n&lt;p&gt;Make a POST  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/transferRoutes\\\/calculate&lt;\\\/a&gt; request. Provide the following parameters in the request body:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Parameter&lt;\\\/th&gt;\\n&lt;th style=\\&quot;text-align: center;\\&quot;&gt;Required&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-balancePlatform\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balancePlatform&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The unique identifier of your balance platform.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-currency\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;currency&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The three-character ISO currency code of the transfer.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-category\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;category&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The type of transfer. Set to &lt;strong&gt;bank&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-counterparty\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;counterparty&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/required\\\/required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;An object that contains information about the recipient of the funds transfer. The counterparty can be a third-party bank account or a transfer instrument.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-priorities\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;priorities&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;\\\/td&gt;\\n&lt;td&gt;An array that contains the priorities that you want to calculate transfer routes for. For example: &lt;strong&gt;regular&lt;\\\/strong&gt;, &lt;strong&gt;fast&lt;\\\/strong&gt;, &lt;strong&gt;wire&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt; &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/transferRoutes\\\/calculate#request-balanceAccountId\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balanceAccountId&lt;\\\/a&gt;&lt;\\\/td&gt;\\n&lt;td style=\\&quot;text-align: center;\\&quot;&gt;&lt;span class=\\&quot;hint--bottom\\&quot; data-hint=\\&quot;Conditionally required\\&quot; markdown=\\&quot;1\\&quot;&gt;&lt;img style=\\&quot;width: 25px;\\&quot; alt=\\&quot;Conditionally required\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/image-library\\\/01.icons\\\/conditionally-required\\\/conditionally-required.svg?decoding=auto&amp;amp;fetchpriority=auto\\&quot; \\\/&gt;&lt;\\\/span&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The unique identifier of the source balance account. Required if &lt;code&gt;counterparty&lt;\\\/code&gt; contains a &lt;strong&gt;transferInstrumentId&lt;\\\/strong&gt;.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;p&gt;The following example shows how to make a request to calculate transfer routes for a specific counterparty.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Example request\\u2014Calculate transfer routes by counterparty&#039;\\&quot; :id=\\&quot;&#039;calculate-transfer-routes-counterparty&#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\\\\\\\/transferRoutes\\\\\\\/calculate \\\\\\\\\\\\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;balancePlatform\\\\&amp;quot;: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n    \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n    \\\\&amp;quot;category\\\\&amp;quot;: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n    \\\\&amp;quot;priorities\\\\&amp;quot;: [\\\\n        \\\\&amp;quot;instant\\\\&amp;quot;,\\\\n        \\\\&amp;quot;wire\\\\&amp;quot;\\\\n    ],\\\\n    \\\\&amp;quot;counterparty\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;bankAccount\\\\&amp;quot;: {\\\\n            \\\\&amp;quot;accountIdentification\\\\&amp;quot;: {\\\\n                \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;iban\\\\&amp;quot;,\\\\n                \\\\&amp;quot;iban\\\\&amp;quot;: \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;\\\\n            }\\\\n        }\\\\n    }\\\\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 v40.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)\\\\nIbanAccountIdentification ibanAccountIdentification = new IbanAccountIdentification()\\\\n  .iban(\\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;)\\\\n  .type(IbanAccountIdentification.TypeEnum.IBAN);\\\\n\\\\nBankAccount bankAccount = new BankAccount()\\\\n  .accountIdentification(new TransferRouteRequestAccountIdentification(ibanAccountIdentification));\\\\n\\\\nCounterparty counterparty = new Counterparty()\\\\n  .bankAccount(bankAccount);\\\\n\\\\nTransferRouteRequest transferRouteRequest = new TransferRouteRequest()\\\\n  .priorities(Arrays.asList(TransferRouteRequest.PrioritiesEnum.INSTANT,\\\\nTransferRouteRequest.PrioritiesEnum.WIRE))\\\\n  .counterparty(counterparty)\\\\n  .currency(\\\\&amp;quot;EUR\\\\&amp;quot;)\\\\n  .category(TransferRouteRequest.CategoryEnum.BANK)\\\\n  .balancePlatform(\\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nTransferRoutesApi service = new TransferRoutesApi(client);\\\\nTransferRouteResponse response = service.calculateTransferRoutes(transferRouteRequest, 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 v28.3.0\\\\nuse Adyen\\\\\\\\Client;\\\\nuse Adyen\\\\\\\\Environment;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\TransferRouteRequestAccountIdentification;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\BankAccount;\\\\nuse Adyen\\\\\\\\Model\\\\\\\\BalancePlatform\\\\\\\\Counterparty;\\\\nuse Adyen\\\\\\\\Service\\\\\\\\BalancePlatform\\\\\\\\TransferRoutesApi;\\\\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$transferRouteRequestAccountIdentification = new TransferRouteRequestAccountIdentification();\\\\n$transferRouteRequestAccountIdentification\\\\n  -&amp;gt;setIban(\\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;)\\\\n  -&amp;gt;setType(\\\\&amp;quot;iban\\\\&amp;quot;);\\\\n\\\\n$bankAccount = new BankAccount();\\\\n$bankAccount\\\\n  -&amp;gt;setAccountIdentification($transferRouteRequestAccountIdentification);\\\\n\\\\n$counterparty = new Counterparty();\\\\n$counterparty\\\\n  -&amp;gt;setBankAccount($bankAccount);\\\\n\\\\n$transferRouteRequest = new TransferRouteRequest();\\\\n$transferRouteRequest\\\\n  -&amp;gt;setPriorities(array(\\\\&amp;quot;instant\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot;))\\\\n  -&amp;gt;setCounterparty($counterparty)\\\\n  -&amp;gt;setCurrency(\\\\&amp;quot;EUR\\\\&amp;quot;)\\\\n  -&amp;gt;setCategory(\\\\&amp;quot;bank\\\\&amp;quot;)\\\\n  -&amp;gt;setBalancePlatform(\\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;);\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\n$service = new TransferRoutesApi($client);\\\\n$response = $service-&amp;gt;calculateTransferRoutes($transferRouteRequest);&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 v32.2.1\\\\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)\\\\nIbanAccountIdentification ibanAccountIdentification = new IbanAccountIdentification\\\\n{\\\\n  Iban = \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;,\\\\n  Type = IbanAccountIdentification.TypeEnum.Iban\\\\n};\\\\n\\\\nBankAccount bankAccount = new BankAccount\\\\n{\\\\n  AccountIdentification = new TransferRouteRequestAccountIdentification(ibanAccountIdentification)\\\\n};\\\\n\\\\nCounterparty counterparty = new Counterparty\\\\n{\\\\n  BankAccount = bankAccount\\\\n};\\\\n\\\\nTransferRouteRequest transferRouteRequest = new TransferRouteRequest\\\\n{\\\\n  Priorities = { TransferRouteRequest.PrioritiesEnum.Instant,\\\\n    TransferRouteRequest.PrioritiesEnum.Wire },\\\\n  Counterparty = counterparty,\\\\n  Currency = \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  Category = TransferRouteRequest.CategoryEnum.Bank,\\\\n  BalancePlatform = \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nvar service = new TransferRoutesService(client);\\\\nvar response = service.CalculateTransferRoutes(transferRouteRequest);&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 v30.0.1\\\\nconst { Client, BalancePlatformAPI } = require(&#039;@adyen\\\\\\\/api-library&#039;);\\\\n\\\\nconst config = new Config({\\\\n  apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  environment: EnvironmentEnum.TEST\\\\n});\\\\n\\\\nconst client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst transferRouteRequest = {\\\\n  balancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n  currency: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  category: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  priorities: [ \\\\&amp;quot;instant\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot; ],\\\\n  counterparty: {\\\\n    bankAccount: {\\\\n      accountIdentification: {\\\\n        type: \\\\&amp;quot;iban\\\\&amp;quot;,\\\\n        iban: \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;\\\\n      }\\\\n    }\\\\n  }\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.TransferRoutesApi.calculateTransferRoutes(transferRouteRequest);&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 v21.1.0\\\\nimport (\\\\n  \\\\&amp;quot;context\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/src\\\\\\\/common\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/src\\\\\\\/adyen\\\\&amp;quot;\\\\n  \\\\&amp;quot;github.com\\\\\\\/adyen\\\\\\\/adyen-go-api-library\\\\\\\/v21\\\\\\\/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)\\\\nibanAccountIdentification := balancePlatform.IbanAccountIdentification{\\\\n  Iban: \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;,\\\\n  Type: \\\\&amp;quot;iban\\\\&amp;quot;,\\\\n}\\\\n\\\\nbankAccount := balancePlatform.BankAccount{\\\\n  AccountIdentification: balancePlatform.IbanAccountIdentificationAsTransferRouteRequestAccountIdentification(&amp;amp;ibanAccountIdentification),\\\\n}\\\\n\\\\ncounterparty := balancePlatform.Counterparty{\\\\n  BankAccount: &amp;amp;bankAccount,\\\\n}\\\\n\\\\ntransferRouteRequest := balancePlatform.TransferRouteRequest{\\\\n  Priorities: []string{\\\\n    \\\\&amp;quot;instant\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot;,\\\\n  },\\\\n  Counterparty: &amp;amp;counterparty,\\\\n  Currency: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  Category: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  BalancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n}\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nservice := client.BalancePlatform()\\\\nreq := service.TransferRoutesApi.CalculateTransferRoutesInput().TransferRouteRequest(transferRouteRequest)\\\\nres, httpRes, err := service.TransferRoutesApi.CalculateTransferRoutes(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 v14.0.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;balancePlatform\\\\&amp;quot;: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;,\\\\n  \\\\&amp;quot;currency\\\\&amp;quot;: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  \\\\&amp;quot;category\\\\&amp;quot;: \\\\&amp;quot;bank\\\\&amp;quot;,\\\\n  \\\\&amp;quot;priorities\\\\&amp;quot;: [ \\\\&amp;quot;instant\\\\&amp;quot;, \\\\&amp;quot;wire\\\\&amp;quot; ],\\\\n  \\\\&amp;quot;counterparty\\\\&amp;quot;: {\\\\n    \\\\&amp;quot;bankAccount\\\\&amp;quot;: {\\\\n      \\\\&amp;quot;accountIdentification\\\\&amp;quot;: {\\\\n        \\\\&amp;quot;type\\\\&amp;quot;: \\\\&amp;quot;iban\\\\&amp;quot;,\\\\n        \\\\&amp;quot;iban\\\\&amp;quot;: \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;\\\\n      }\\\\n    }\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.transfer_routes_api.calculate_transfer_routes(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 v11.1.0\\\\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  :balancePlatform =&amp;gt; &#039;YOUR_BALANCE_PLATFORM&#039;,\\\\n  :currency =&amp;gt; &#039;EUR&#039;,\\\\n  :category =&amp;gt; &#039;bank&#039;,\\\\n  :priorities =&amp;gt; [ &#039;instant&#039;, &#039;wire&#039; ],\\\\n  :counterparty =&amp;gt; {\\\\n    :bankAccount =&amp;gt; {\\\\n      :accountIdentification =&amp;gt; {\\\\n        :type =&amp;gt; &#039;iban&#039;,\\\\n        :iban =&amp;gt; &#039;NL91ABNA0417164300&#039;\\\\n      }\\\\n    }\\\\n  }\\\\n}\\\\n\\\\n# Send the request\\\\nresult = adyen.balancePlatform.transfer_routes_api.calculate_transfer_routes(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 v30.0.1\\\\nimport { Client, BalancePlatformAPI, Types } from \\\\&amp;quot;@adyen\\\\\\\/api-library\\\\&amp;quot;;\\\\n\\\\nconst config = new Config({\\\\n  apiKey: \\\\&amp;quot;ADYEN_BALANCE_PLATFORM_API_KEY\\\\&amp;quot;,\\\\n  environment: EnvironmentEnum.TEST\\\\n});\\\\n\\\\nconst client = new Client(config);\\\\n\\\\n\\\\\\\/\\\\\\\/ Create the request object(s)\\\\nconst ibanAccountIdentification: Types.balancePlatform.IbanAccountIdentification = {\\\\n  iban: \\\\&amp;quot;NL91ABNA0417164300\\\\&amp;quot;,\\\\n  type: Types.balancePlatform.IbanAccountIdentification.TypeEnum.Iban\\\\n};\\\\n\\\\nconst bankAccount: Types.balancePlatform.BankAccount = {\\\\n  accountIdentification: ibanAccountIdentification\\\\n};\\\\n\\\\nconst counterparty: Types.balancePlatform.Counterparty = {\\\\n  bankAccount: bankAccount\\\\n};\\\\n\\\\nconst transferRouteRequest: Types.balancePlatform.TransferRouteRequest = {\\\\n  priorities: [\\\\n    Types.balancePlatform.TransferRouteRequest.PrioritiesEnum.Instant,\\\\n    Types.balancePlatform.TransferRouteRequest.PrioritiesEnum.Wire\\\\n  ],\\\\n  counterparty: counterparty,\\\\n  currency: \\\\&amp;quot;EUR\\\\&amp;quot;,\\\\n  category: Types.balancePlatform.TransferRouteRequest.CategoryEnum.Bank,\\\\n  balancePlatform: \\\\&amp;quot;YOUR_BALANCE_PLATFORM\\\\&amp;quot;\\\\n};\\\\n\\\\n\\\\\\\/\\\\\\\/ Send the request\\\\nconst balancePlatformAPI = new BalancePlatformAPI(client);\\\\nconst response = balancePlatformAPI.TransferRoutesApi.calculateTransferRoutes(transferRouteRequest);&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;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;In the response, note the &lt;code&gt;transferRoutes&lt;\\\/code&gt; object, which includes all transfer routes supported by a counterparty. Each transfer route specifies:&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;The country of the counterparty.&lt;\\\/li&gt;\\n&lt;li&gt;The supported currency.&lt;\\\/li&gt;\\n&lt;li&gt;The supported priority.&lt;\\\/li&gt;\\n&lt;li&gt;Any additional requirements you must fulfill when using the transfer route.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n&lt;code-sample :title=\\&quot;&#039;Example response\\u2014Transfer routes by counterparty&#039;\\&quot; :id=\\&quot;&#039;&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;transferRoutes\\\\\\&quot;: [\\\\n        {\\\\n            \\\\\\&quot;country\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n            \\\\\\&quot;priority\\\\\\&quot;: \\\\\\&quot;instant\\\\\\&quot;,\\\\n            \\\\\\&quot;requirements\\\\\\&quot;: [\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Amount of transfer must be at least 1, and no greater than 9999999\\\\\\&quot;,\\\\n                    \\\\\\&quot;max\\\\\\&quot;: 9999999,\\\\n                    \\\\\\&quot;min\\\\\\&quot;: 1,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;amountMinMaxRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Bank account identification type must be iban\\\\\\&quot;,\\\\n                    \\\\\\&quot;bankAccountIdentificationTypes\\\\\\&quot;: [\\\\n                        \\\\\\&quot;iban\\\\\\&quot;\\\\n                    ],\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;bankAccountIdentificationTypeRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;issuingCountryCode\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n                    \\\\\\&quot;paymentInstrumentType\\\\\\&quot;: \\\\\\&quot;BankAccount\\\\\\&quot;,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;paymentInstrumentRequirement\\\\\\&quot;\\\\n                }\\\\n            ]\\\\n        },\\\\n        {\\\\n            \\\\\\&quot;country\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n            \\\\\\&quot;priority\\\\\\&quot;: \\\\\\&quot;wire\\\\\\&quot;,\\\\n            \\\\\\&quot;requirements\\\\\\&quot;: [\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Amount of transfer must be at least 1, and no greater than 99999999999\\\\\\&quot;,\\\\n                    \\\\\\&quot;max\\\\\\&quot;: 99999999999,\\\\n                    \\\\\\&quot;min\\\\\\&quot;: 1,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;amountMinMaxRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;issuingCountryCode\\\\\\&quot;: \\\\\\&quot;NL\\\\\\&quot;,\\\\n                    \\\\\\&quot;paymentInstrumentType\\\\\\&quot;: \\\\\\&quot;BankAccount\\\\\\&quot;,\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;paymentInstrumentRequirement\\\\\\&quot;\\\\n                },\\\\n                {\\\\n                    \\\\\\&quot;description\\\\\\&quot;: \\\\\\&quot;Bank account identification type must be iban\\\\\\&quot;,\\\\n                    \\\\\\&quot;bankAccountIdentificationTypes\\\\\\&quot;: [\\\\n                        \\\\\\&quot;iban\\\\\\&quot;\\\\n                    ],\\\\n                    \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;bankAccountIdentificationTypeRequirement\\\\\\&quot;\\\\n                }\\\\n            ]\\\\n        }\\\\n    ]\\\\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&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;calculate_transfer_routes_by_counterparty_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/getting-paid\/transfer-routes","articleFields":{"description":"Learn how to get the optimal routes for your payouts.","cache_enable":false,"next_steps":[{"title":"Set up scheduled payouts","description":"Trigger automatic payouts based on a schedule and amount.","url":"\/platforms\/payout-to-users\/scheduled-payouts","required":false},{"title":"Send on-demand payouts","description":"Make an off-schedule payout to your users.","url":"\/platforms\/payout-to-users\/on-demand-payouts","required":false}],"parameters":{"directoryPath":"\/platforms","model":"platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/getting-paid\/transfer-routes","title":"Transfer routes","content":"Sending funds to transfer instruments can have additional requirements or limitations. For example, the bank that holds your user's transfer instrument may only support specific transfer priorities, or limit the amount of funds that you can send. These requirements or limitations are set by the bank or its regulating entities.\nTo prevent transfer failures due to such limitations, we recommend that you calculate the available transfer routes before sending funds to a new recipient.\nRequirements\nBefore you begin, consider the following requirements:\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have an Adyen for Platforms integration.\n\n\nAPI credential roles\nYour API credential for the  Configuration API must have the following role: Balance Platform BCL role\n\n\n\nCalculate transfer routes\nYou can make calculate all available transfer routes for either a specific location or a set of counterparty bank details. The following tabs explain both of these methods.\n\n\n    \n        \n        \n    \n\n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Getting paid","lvl4":"Transfer routes"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payouts","lvl2":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service","lvl3":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/getting-paid","lvl4":"\/pt\/payouts\/payout-service\/getting-paid\/transfer-routes"},"levels":5,"category":"","category_color":"","tags":["Transfer","routes"]}}
