{"title":"Manage transfer instruments","category":"default","creationDate":1679993280,"content":"<p>A transfer instrument is an API resource that represents an external bank account. You can use transfer instruments to send funds to and receive funds from bank accounts outside of your platform. These transfers can be made <a href=\"\/pt\/payouts\/payout-service\/getting-paid\/on-demand-payouts\">on-demand<\/a> or generated by <a href=\"\/pt\/payouts\/payout-service\/getting-paid\/scheduled-payouts\">automated sweeps<\/a>. <\/p>\n<p>There are two main types of transfer instruments:<\/p>\n<ul>\n<li><strong>Your users' bank accounts<\/strong>: These are the bank accounts of the <a href=\"\/pt\/platforms\/manage-account-holders\/\">account holders<\/a> on your platform.<\/li>\n<li><strong>Your payout accounts<\/strong>: These are your own company's bank accounts that you add to your platform. Adyen uses these accounts to settle funds to you. In an Adyen for Platforms integration, these are the transfer instruments that are connected to your liable account. <\/li>\n<\/ul>\n<p>This page explains how to create, view, update, and delete transfer instruments for your users using the API, and how to manage your platform's payout accounts in the Customer Area.<\/p>\n<h2>Requirements<\/h2>\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;\">Adyen for platforms<\/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;\">Make sure that you have a <span translate=\"no\"><strong>Legal Entity Management<\/strong><\/span> web service user with the following roles <ul><li markdown=\"1\"><strong>Manage LegalEntities via API<\/strong><\/li><li markdown=\"1\"><strong>Balance Platform BCL Legal Entity role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have the following role: <ul><li markdown=\"1\"><strong>Manage account holders &amp; legal entities<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Manage transfer instruments with the API<\/h2>\n<p>Use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a> to manage the transfer instruments that belong to you users or your platform. With the API you can:<\/p>\n<ul>\n<li><a href=\"#create-a-transfer-instrument\">Create a transfer instrument<\/a><\/li>\n<li><a href=\"#view-transfer-instruments\">View transfer instruments<\/a><\/li>\n<li><a href=\"#update-a-transfer-instrument\">Update a transfer instrument<\/a><\/li>\n<li><a href=\"#delete-a-transfer-instrument\">Delete a transfer instrument<\/a><\/li>\n<\/ul>\n<h2>Create a transfer instrument<\/h2>\n<p>To create a transfer instrument:<\/p>\n<ol>\n<li>\n<p>Make a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/transferInstruments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments<\/a> request specifying the following: <\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/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\/legalentity\/latest\/post\/legalEntities#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\/legalentity\/latest\/post\/transferInstruments#request-legalEntityId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">legalEntityId<\/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>Unique identifier of the legal entity that has the contractual relationship with your platform and owns the bank account. For sole proprietorships, this is the legal entity ID of the individual owner.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/transferInstruments#request-bankAccount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bankAccount<\/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>Object that contains required information about the legal entity's bank account. The required parameters of this object depend on the location of your bank. Refer to  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/patch\/transferInstruments\/(id)#request-bankAccount-accountIdentification\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bankAccount\/accountIdentification<\/a> in the API Explorer to confirm which parameters are valid for each location.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Here is an example request to add a transfer instrument for a bank account in the US:<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Create a bank account as a transfer instrument'\" :id=\"'post-transfer-instruments'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/kyc-test.adyen.com\\\/lem\\\/v3\\\/transferInstruments \\\\\\n-H 'x-api-key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST \\\\\\n-d '{\\n   \\&quot;legalEntityId\\&quot;:\\&quot;LE00000000000000000000001\\&quot;,\\n   \\&quot;type\\&quot;:\\&quot;bankAccount\\&quot;,\\n   \\&quot;bankAccount\\&quot;:{\\n      \\&quot;accountIdentification\\&quot;:{\\n         \\&quot;type\\&quot;:\\&quot;usLocal\\&quot;,\\n         \\&quot;accountNumber\\&quot;:\\&quot;0000000123\\&quot;,\\n         \\&quot;routingNumber\\&quot;:\\&quot;121202211\\&quot;\\n      }\\n   }\\n}'&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v39.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.legalentitymanagement.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.legalEntityManagement.*;\\n\\nClient client = new Client(\\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, Environment.TEST);\\n\\n\\\/\\\/ Create the request object(s)\\nUSLocalAccountIdentification uSLocalAccountIdentification = new USLocalAccountIdentification()\\n  .routingNumber(\\&quot;121202211\\&quot;)\\n  .type(USLocalAccountIdentification.TypeEnum.USLOCAL)\\n  .accountNumber(\\&quot;0000000123\\&quot;);\\n\\nBankAccountInfo bankAccountInfo = new BankAccountInfo()\\n  .accountIdentification(new TransferInstrumentInfoAccountIdentification(uSLocalAccountIdentification));\\n\\nTransferInstrumentInfo transferInstrumentInfo = new TransferInstrumentInfo()\\n  .bankAccount(bankAccountInfo)\\n  .legalEntityId(\\&quot;LE00000000000000000000001\\&quot;)\\n  .type(TransferInstrumentInfo.TypeEnum.BANKACCOUNT);\\n\\n\\\/\\\/ Send the request\\nTransferInstrumentsApi service = new TransferInstrumentsApi(client);\\nTransferInstrument response = service.createTransferInstrument(transferInstrumentInfo, 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 v28.1.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Model\\\\LegalEntityManagement\\\\TransferInstrumentInfoAccountIdentification;\\nuse Adyen\\\\Model\\\\LegalEntityManagement\\\\BankAccountInfo;\\nuse Adyen\\\\Service\\\\LegalEntityManagement\\\\TransferInstrumentsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\n\\\/\\\/ Create the request object(s)\\n$transferInstrumentInfoAccountIdentification = new TransferInstrumentInfoAccountIdentification();\\n$transferInstrumentInfoAccountIdentification\\n  -&gt;setRoutingNumber(\\&quot;121202211\\&quot;)\\n  -&gt;setType(\\&quot;usLocal\\&quot;)\\n  -&gt;setAccountNumber(\\&quot;0000000123\\&quot;);\\n\\n$bankAccountInfo = new BankAccountInfo();\\n$bankAccountInfo\\n  -&gt;setAccountIdentification($transferInstrumentInfoAccountIdentification);\\n\\n$transferInstrumentInfo = new TransferInstrumentInfo();\\n$transferInstrumentInfo\\n  -&gt;setBankAccount($bankAccountInfo)\\n  -&gt;setLegalEntityId(\\&quot;LE00000000000000000000001\\&quot;)\\n  -&gt;setType(\\&quot;bankAccount\\&quot;);\\n\\n\\\/\\\/ Send the request\\n$service = new TransferInstrumentsApi($client);\\n$response = $service-&gt;createTransferInstrument($transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v32.0.1\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.LegalEntityManagement;\\nusing Adyen.Service.LegalEntityManagement;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Create the request object(s)\\nUSLocalAccountIdentification uSLocalAccountIdentification = new USLocalAccountIdentification\\n{\\n  RoutingNumber = \\&quot;121202211\\&quot;,\\n  Type = USLocalAccountIdentification.TypeEnum.UsLocal,\\n  AccountNumber = \\&quot;0000000123\\&quot;\\n};\\n\\nBankAccountInfo bankAccountInfo = new BankAccountInfo\\n{\\n  AccountIdentification = new TransferInstrumentInfoAccountIdentification(uSLocalAccountIdentification)\\n};\\n\\nTransferInstrumentInfo transferInstrumentInfo = new TransferInstrumentInfo\\n{\\n  BankAccount = bankAccountInfo,\\n  LegalEntityId = \\&quot;LE00000000000000000000001\\&quot;,\\n  Type = TransferInstrumentInfo.TypeEnum.BankAccount\\n};\\n\\n\\\/\\\/ Send the request\\nvar service = new TransferInstrumentsService(client);\\nvar response = service.CreateTransferInstrument(transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nconst { Client, LegalEntityManagementAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst transferInstrumentInfo = {\\n  legalEntityId: \\&quot;LE00000000000000000000001\\&quot;,\\n  type: \\&quot;bankAccount\\&quot;,\\n  bankAccount: {\\n    accountIdentification: {\\n      type: \\&quot;usLocal\\&quot;,\\n      accountNumber: \\&quot;0000000123\\&quot;,\\n      routingNumber: \\&quot;121202211\\&quot;\\n    }\\n  }\\n}\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.createTransferInstrument(transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v21.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/legalEntityManagement\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Create the request object(s)\\nuSLocalAccountIdentification := legalEntityManagement.USLocalAccountIdentification{\\n  RoutingNumber: \\&quot;121202211\\&quot;,\\n  Type: \\&quot;usLocal\\&quot;,\\n  AccountNumber: \\&quot;0000000123\\&quot;,\\n}\\n\\nbankAccountInfo := legalEntityManagement.BankAccountInfo{\\n  AccountIdentification: legalEntityManagement.USLocalAccountIdentificationAsTransferInstrumentInfoAccountIdentification(&amp;uSLocalAccountIdentification),\\n}\\n\\ntransferInstrumentInfo := legalEntityManagement.TransferInstrumentInfo{\\n  BankAccount: bankAccountInfo,\\n  LegalEntityId: \\&quot;LE00000000000000000000001\\&quot;,\\n  Type: \\&quot;bankAccount\\&quot;,\\n}\\n\\n\\\/\\\/ Send the request\\nservice := client.LegalEntityManagement()\\nreq := service.TransferInstrumentsApi.CreateTransferInstrumentInput().TransferInstrumentInfo(transferInstrumentInfo)\\nres, httpRes, err := service.TransferInstrumentsApi.CreateTransferInstrument(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.5.1\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_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;legalEntityId\\&quot;: \\&quot;LE00000000000000000000001\\&quot;,\\n  \\&quot;type\\&quot;: \\&quot;bankAccount\\&quot;,\\n  \\&quot;bankAccount\\&quot;: {\\n    \\&quot;accountIdentification\\&quot;: {\\n      \\&quot;type\\&quot;: \\&quot;usLocal\\&quot;,\\n      \\&quot;accountNumber\\&quot;: \\&quot;0000000123\\&quot;,\\n      \\&quot;routingNumber\\&quot;: \\&quot;121202211\\&quot;\\n    }\\n  }\\n}\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.create_transfer_instrument(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.3.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nrequest_body = {\\n  :legalEntityId =&gt; 'LE00000000000000000000001',\\n  :type =&gt; 'bankAccount',\\n  :bankAccount =&gt; {\\n    :accountIdentification =&gt; {\\n      :type =&gt; 'usLocal',\\n      :accountNumber =&gt; '0000000123',\\n      :routingNumber =&gt; '121202211'\\n    }\\n  }\\n}\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.create_transfer_instrument(request_body)&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nimport { Client, LegalEntityManagementAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst uSLocalAccountIdentification: Types.legalEntityManagement.USLocalAccountIdentification = {\\n  routingNumber: \\&quot;121202211\\&quot;,\\n  type: Types.legalEntityManagement.USLocalAccountIdentification.TypeEnum.UsLocal,\\n  accountNumber: \\&quot;0000000123\\&quot;\\n};\\n\\nconst bankAccountInfo: Types.legalEntityManagement.BankAccountInfo = {\\n  accountIdentification: uSLocalAccountIdentification\\n};\\n\\nconst transferInstrumentInfo: Types.legalEntityManagement.TransferInstrumentInfo = {\\n  bankAccount: bankAccountInfo,\\n  legalEntityId: \\&quot;LE00000000000000000000001\\&quot;,\\n  type: Types.legalEntityManagement.TransferInstrumentInfo.TypeEnum.BankAccount\\n};\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.createTransferInstrument(transferInstrumentInfo);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Read the response. It contains the transfer instrument resource, identified by its unique <code>id<\/code>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'create-transferInstrument'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n\\\"bankAccount\\\": {\\n  \\\"accountIdentification\\\": {\\n    \\\"type\\\": \\\"usLocal\\\",\\n    \\\"accountNumber\\\": \\\"0000000123\\\",\\n    \\\"accountType\\\": \\\"checking\\\",\\n    \\\"routingNumber\\\": \\\"121202211\\\"\\n  },\\n  \\\"countryCode\\\": \\\"US\\\",\\n  \\\"trustedSource\\\": false\\n},\\n\\\"legalEntityId\\\": \\\"LE00000000000000000000001\\\",\\n\\\"type\\\": \\\"bankAccount\\\",\\n\\\"capabilities\\\": {\\n  \\\"sendToTransferInstrument\\\": {\\n    \\\"allowed\\\": false,\\n    \\\"requested\\\": true,\\n    \\\"verificationStatus\\\": \\\"pending\\\"\\n  }\\n},\\n\\\"id\\\": \\\"SE322JV223222F5GJVKHH8DTC\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Look for  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/patch\/transferInstruments\/(id)#responses-200-problems\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">problems<\/a> in the response. The <code>problems<\/code> array contains information about which bank account verifications had issues. See <a href=\"\/pt\/marketplaces\/kyc-verification-codes\/remediating-actions\/#bank-checks\">Remediating actions<\/a> for a list of possible remediating action codes and what they mean. <\/p>\n<\/li>\n<\/ol>\n<p>The result is a new transfer instrument with a unique ID. Use this ID to <a href=\"\/pt\/platforms\/payout-to-users\/scheduled-payouts\">create a sweep<\/a>, or as a target for a <a href=\"\/pt\/platforms\/payout-to-users\/on-demand-payouts\">manual transfer<\/a>.<\/p>\n<h2>View transfer instruments<\/h2>\n<p>To view transfer instrument details:<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/get\/transferInstruments\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments\/{id}<\/a> specifying unique <code>transferInstrumentId<\/code> of the transfer instrument you want to view.<\/p>\n<table>\n<thead>\n<tr>\n<th>Path parameter<\/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\/legalentity\/latest\/get\/transferInstruments\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments\/{id}<\/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 unique identifier of the transfer instrument to retrieve.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'GET \/transferInstruments'\" :id=\"'get-transfer-instruments'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/kyc-test.adyen.com\\\/lem\\\/v4\\\/transferInstruments\\\/{id} \\\\\\n  -H 'x-api-key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY' \\\\\\n  -H 'content-type: application\\\/json' \\\\\\n  -X GET&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v39.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.legalentitymanagement.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.legalEntityManagement.*;\\n\\nClient client = new Client(\\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, Environment.TEST);\\n\\\/\\\/ Send the request\\nTransferInstrumentsApi service = new TransferInstrumentsApi(client);\\nTransferInstrument response = service.getTransferInstrument(\\&quot;id\\&quot;, 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 v28.1.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Service\\\\LegalEntityManagement\\\\TransferInstrumentsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\\/\\\/ Send the request\\n$service = new TransferInstrumentsApi($client);\\n$response = $service-&gt;getTransferInstrument('id');&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v32.0.1\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.LegalEntityManagement;\\nusing Adyen.Service.LegalEntityManagement;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Send the request\\nvar service = new TransferInstrumentsService(client);\\nvar response = service.GetTransferInstrument(\\&quot;id\\&quot;);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nconst { Client, LegalEntityManagementAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.getTransferInstrument(\\&quot;id\\&quot;);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v21.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/legalEntityManagement\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Send the request\\nservice := client.LegalEntityManagement()\\nreq := service.TransferInstrumentsApi.GetTransferInstrumentInput(\\&quot;id\\&quot;)\\nres, httpRes, err := service.TransferInstrumentsApi.GetTransferInstrument(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.5.1\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.get_transfer_instrument(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.3.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.get_transfer_instrument('id')&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nimport { Client, LegalEntityManagementAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.getTransferInstrument(\\&quot;id\\&quot;);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Read the response. A successful response, indicated by a 200 HTTP reponse code, contains the transfer instrument object with information about the bank account, such as the account number, account holder name, and verification status.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Example GET \/transferInstruments response'\" :id=\"'edit-transferInstrument-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"bankAccount\\\": {\\n    \\\"accountIdentification\\\": {\\n      \\\"type\\\": \\\"iban\\\",\\n      \\\"iban\\\": \\\"NL62ABNA0000000123\\\"\\n    },\\n    \\\"countryCode\\\": \\\"NL\\\"\\n  },\\n  \\\"legalEntityId\\\": \\\"LE00000000000000000000001\\\",\\n  \\\"type\\\": \\\"bankAccount\\\",\\n  \\\"id\\\": \\\"SE322KH223222F5GXZFNM3BGP\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>Update a transfer instrument<\/h2>\n<p>To update a transfer instrument:<\/p>\n<ol>\n<li>\n<p>Make a PATCH  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/patch\/transferInstruments\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments\/{id}<\/a> specifying the unique <code>transferInstrumentId<\/code> of the account you want to update. Only provide values for the fields you want to modify. If you are updating the <code>bankAccount<\/code> object, check  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/patch\/transferInstruments\/(id)#request-bankAccount-accountIdentification\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bankAccount\/accountIdentification<\/a> in the API Explorer to confirm which parameters are valid for each location.<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/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\/legalentity\/latest\/patch\/transferInstruments\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments\/{id}<\/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 unique identifier of the transfer instrument to update.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The following example shows how to update the bank account with a new IBAN.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Change the bank account for a transfer instrument'\" :id=\"'patch-transfer-instruments'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/kyc-test.adyen.com\\\/lem\\\/v4\\\/transferInstruments\\\/{id} \\\\\\n  -X PATCH \\\\\\n  -H 'X-API-Key: YOUR_API_KEY' \\\\\\n  -H 'Content-Type: application\\\/json' \\\\\\n  -d '{\\n      \\&quot;bankAccount\\&quot;: {\\n        \\&quot;accountIdentification\\&quot;: {\\n          \\&quot;type\\&quot;: \\&quot;iban\\&quot;,\\n          \\&quot;iban\\&quot;: \\&quot;NL62ABNA0000000456\\&quot;\\n        }\\n      }\\n    }'&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v39.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.legalentitymanagement.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.legalEntityManagement.*;\\n\\nClient client = new Client(\\&quot;YOUR_API_KEY\\&quot;, Environment.TEST);\\n\\n\\\/\\\/ Create the request object(s)\\nIbanAccountIdentification ibanAccountIdentification = new IbanAccountIdentification()\\n  .iban(\\&quot;NL62ABNA0000000456\\&quot;)\\n  .type(IbanAccountIdentification.TypeEnum.IBAN);\\n\\nBankAccountInfo bankAccountInfo = new BankAccountInfo()\\n  .accountIdentification(new TransferInstrumentInfoAccountIdentification(ibanAccountIdentification));\\n\\nTransferInstrumentInfo transferInstrumentInfo = new TransferInstrumentInfo()\\n  .bankAccount(bankAccountInfo);\\n\\n\\\/\\\/ Send the request\\nTransferInstrumentsApi service = new TransferInstrumentsApi(client);\\nTransferInstrument response = service.updateTransferInstrument(\\&quot;id\\&quot;, transferInstrumentInfo, 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 v28.1.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Model\\\\LegalEntityManagement\\\\TransferInstrumentInfoAccountIdentification;\\nuse Adyen\\\\Model\\\\LegalEntityManagement\\\\BankAccountInfo;\\nuse Adyen\\\\Service\\\\LegalEntityManagement\\\\TransferInstrumentsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;YOUR_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\n\\\/\\\/ Create the request object(s)\\n$transferInstrumentInfoAccountIdentification = new TransferInstrumentInfoAccountIdentification();\\n$transferInstrumentInfoAccountIdentification\\n  -&gt;setIban(\\&quot;NL62ABNA0000000456\\&quot;)\\n  -&gt;setType(\\&quot;iban\\&quot;);\\n\\n$bankAccountInfo = new BankAccountInfo();\\n$bankAccountInfo\\n  -&gt;setAccountIdentification($transferInstrumentInfoAccountIdentification);\\n\\n$transferInstrumentInfo = new TransferInstrumentInfo();\\n$transferInstrumentInfo\\n  -&gt;setBankAccount($bankAccountInfo);\\n\\n\\\/\\\/ Send the request\\n$service = new TransferInstrumentsApi($client);\\n$response = $service-&gt;updateTransferInstrument('id', $transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v32.0.1\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.LegalEntityManagement;\\nusing Adyen.Service.LegalEntityManagement;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;YOUR_API_KEY\\&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 = \\&quot;NL62ABNA0000000456\\&quot;,\\n  Type = IbanAccountIdentification.TypeEnum.Iban\\n};\\n\\nBankAccountInfo bankAccountInfo = new BankAccountInfo\\n{\\n  AccountIdentification = new TransferInstrumentInfoAccountIdentification(ibanAccountIdentification)\\n};\\n\\nTransferInstrumentInfo transferInstrumentInfo = new TransferInstrumentInfo\\n{\\n  BankAccount = bankAccountInfo\\n};\\n\\n\\\/\\\/ Send the request\\nvar service = new TransferInstrumentsService(client);\\nvar response = service.UpdateTransferInstrument(\\&quot;id\\&quot;, transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nconst { Client, LegalEntityManagementAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;YOUR_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst transferInstrumentInfo = {\\n  bankAccount: {\\n    accountIdentification: {\\n      type: \\&quot;iban\\&quot;,\\n      iban: \\&quot;NL62ABNA0000000456\\&quot;\\n    }\\n  }\\n}\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.updateTransferInstrument(\\&quot;id\\&quot;, transferInstrumentInfo);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v21.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/legalEntityManagement\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;YOUR_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Create the request object(s)\\nibanAccountIdentification := legalEntityManagement.IbanAccountIdentification{\\n  Iban: \\&quot;NL62ABNA0000000456\\&quot;,\\n  Type: \\&quot;iban\\&quot;,\\n}\\n\\nbankAccountInfo := legalEntityManagement.BankAccountInfo{\\n  AccountIdentification: legalEntityManagement.IbanAccountIdentificationAsTransferInstrumentInfoAccountIdentification(&amp;ibanAccountIdentification),\\n}\\n\\ntransferInstrumentInfo := legalEntityManagement.TransferInstrumentInfo{\\n  BankAccount: bankAccountInfo,\\n}\\n\\n\\\/\\\/ Send the request\\nservice := client.LegalEntityManagement()\\nreq := service.TransferInstrumentsApi.UpdateTransferInstrumentInput(\\&quot;id\\&quot;).TransferInstrumentInfo(transferInstrumentInfo)\\nres, httpRes, err := service.TransferInstrumentsApi.UpdateTransferInstrument(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.5.1\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;YOUR_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;bankAccount\\&quot;: {\\n    \\&quot;accountIdentification\\&quot;: {\\n      \\&quot;type\\&quot;: \\&quot;iban\\&quot;,\\n      \\&quot;iban\\&quot;: \\&quot;NL62ABNA0000000456\\&quot;\\n    }\\n  }\\n}\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.update_transfer_instrument(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.3.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'YOUR_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nrequest_body = {\\n  :bankAccount =&gt; {\\n    :accountIdentification =&gt; {\\n      :type =&gt; 'iban',\\n      :iban =&gt; 'NL62ABNA0000000456'\\n    }\\n  }\\n}\\n\\n# Send the request\\nresult = adyen.legalEntityManagement.transfer_instruments_api.update_transfer_instrument(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 v28.0.0\\nimport { Client, LegalEntityManagementAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;YOUR_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Create the request object(s)\\nconst ibanAccountIdentification: Types.legalEntityManagement.IbanAccountIdentification = {\\n  iban: \\&quot;NL62ABNA0000000456\\&quot;,\\n  type: Types.legalEntityManagement.IbanAccountIdentification.TypeEnum.Iban\\n};\\n\\nconst bankAccountInfo: Types.legalEntityManagement.BankAccountInfo = {\\n  accountIdentification: ibanAccountIdentification\\n};\\n\\nconst transferInstrumentInfo: Types.legalEntityManagement.TransferInstrumentInfo = {\\n  bankAccount: bankAccountInfo\\n};\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nconst response = legalEntityManagementAPI.TransferInstrumentsApi.updateTransferInstrument(\\&quot;id\\&quot;, transferInstrumentInfo);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Read the response. A successful response, indicated by a 200 http response code, contains the complete, updated transfer instrument object.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Example PATCH \/transferInstruments response'\" :id=\"'edit-transferInstrument-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"bankAccount\\\": {\\n    \\\"accountIdentification\\\": {\\n      \\\"type\\\": \\\"iban\\\",\\n      \\\"iban\\\": \\\"NL62ABNA0000000456\\\"\\n    },\\n    \\\"countryCode\\\": \\\"NL\\\"\\n  },\\n  \\\"legalEntityId\\\": \\\"LE00000000000000000000001\\\",\\n  \\\"type\\\": \\\"bankAccount\\\",\\n  \\\"id\\\": \\\"SE322KH223222F5GXZFNM3BGP\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Look for  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/patch\/transferInstruments\/(id)#responses-200-problems\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">problems<\/a> in the response. The <code>problems<\/code> array contains information about which bank account verifications had issues. See <a href=\"\/pt\/marketplaces\/kyc-verification-codes\/remediating-actions\/#bank-checks\">Remediating actions<\/a> for a list of possible remediating action codes and what they mean.<\/p>\n<\/li>\n<\/ol>\n<p>The result is an updated bank account that has the same transfer instrument ID. This means that sweeps and transfer requests that target the existing ID still work as expected.<\/p>\n<h2>Delete a transfer instrument<\/h2>\n<p>To delete a transfer instrument, make a DELETE request to the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/delete\/transferInstruments\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transferInstruments\/{id}<\/a> endpoint.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">id<\/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 style=\"text-align: left;\">The unique identifier of the transfer instrument to be deleted.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Here is an example request to delete a transfer instrument:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'DELETE \/transferInstruments'\" :id=\"'delete-transfer-instruments'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/kyc-test.adyen.com\\\/lem\\\/v4\\\/transferInstruments\\\/{id} \\\\\\n  -H 'x-api-key: YOUR_API_KEY' \\\\\\n  -H 'content-type: application\\\/json' \\\\\\n  -X DELETE&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v39.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.service.legalEntityManagement.*;\\n\\nClient client = new Client(\\&quot;YOUR_API_KEY\\&quot;, Environment.TEST);\\n\\\/\\\/ Send the request\\nTransferInstrumentsApi service = new TransferInstrumentsApi(client);\\nservice.deleteTransferInstrument(\\&quot;id\\&quot;, 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 v28.1.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Service\\\\LegalEntityManagement\\\\TransferInstrumentsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;YOUR_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\\/\\\/ Send the request\\n$service = new TransferInstrumentsApi($client);\\n$service-&gt;deleteTransferInstrument('id');&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v32.0.1\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Service.LegalEntityManagement;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;YOUR_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Send the request\\nvar service = new TransferInstrumentsService(client);\\nservice.DeleteTransferInstrument(\\&quot;id\\&quot;);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nconst { Client, LegalEntityManagementAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;YOUR_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nlegalEntityManagementAPI.TransferInstrumentsApi.deleteTransferInstrument(\\&quot;id\\&quot;);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v21.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v21\\\/src\\\/legalEntityManagement\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;YOUR_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Send the request\\nservice := client.LegalEntityManagement()\\nreq := service.TransferInstrumentsApi.DeleteTransferInstrumentInput(\\&quot;id\\&quot;)\\nservice.TransferInstrumentsApi.DeleteTransferInstrument(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.5.1\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;YOUR_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\n# Send the request\\nadyen.legalEntityManagement.transfer_instruments_api.delete_transfer_instrument(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.3.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'YOUR_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Send the request\\nadyen.legalEntityManagement.transfer_instruments_api.delete_transfer_instrument('id')&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v28.0.0\\nimport { Client, LegalEntityManagementAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;YOUR_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst legalEntityManagementAPI = new LegalEntityManagementAPI(client);\\nlegalEntityManagementAPI.TransferInstrumentsApi.deleteTransferInstrument(\\&quot;id\\&quot;);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>You cannot undo a delete request. If you need the same account added back, <a href=\"#create-a-transfer-instrument\">create a new transfer instrument<\/a>. Any future manual transfers or automated sweeps that use the deleted ID will fail. <\/p>\n<h2>Payout accounts<\/h2>\n<p><\/li>\n<\/ul>\n<p>Your platform's payout accounts are transfer instruments that are connected to your liable account. Adyen uses these payout accounts to settle funds to your company's bank accounts. This account is typically set up for you when you get started with Adyen.<\/p>\n<p>You can create multiple payout accounts for your platform. When you need to make changes to your payout accounts, you can <a href=\"#manage-payout-accounts\">use the Customer Area<\/a> or <a href=\"#manage-transfer-instruments-with-the-api\">use the API<\/a>. The Customer Area is only available to manage your platform's payout accounts, not your users' transfer instruments.<\/p>\n<h3>Add a payout account in the Customer Area<\/h3>\n<p>You can create payout accounts for your company in the Customer Area. Use this to create your first payout account, or add payout accounts in additional currencies. <\/p>\n<p>To add a payout account: <\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Navigate to <strong>Finance &gt; Payout accounts<\/strong><\/li>\n<li>Select <strong>Add payout account<\/strong>.<\/li>\n<li>Select your prefered verification method to either log in to your bank, or enter it manually alongside a bank statement<\/li>\n<\/ol>\n<p>Adyen makes the payout account available as soon as it passes verification. If you logged in with your bank, verification happens instantly. You can use the payout account when its status is <strong>valid<\/strong>.<\/p>\n<h3>Edit or remove a payout account in the Customer Area<\/h3>\n<p>To manage your payout accounts:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Navigate to <strong>Finance &gt; Payout accounts<\/strong><\/li>\n<li>Find the payout account you want to change and select the <strong>Remove<\/strong> or <strong>Edit<\/strong> from the options dropdown.<\/li>\n<\/ol>\n<p>Edits to transfer instruments take effect instantly. When you delete a transfer instrument, it stops recieving payouts. If you need restore the same account, <a href=\"#add-a-payout-account\">create a new transfer instrument<\/a>. <a href=\"\/pt\/payouts\/payout-service\/getting-paid\/on-demand-payouts\">Manual transfers<\/a> or <a href=\"\/pt\/payouts\/payout-service\/getting-paid\/scheduled-payouts\">automated sweeps<\/a> that use the deleted ID will begin to fail. <\/p>\n<div class=\"notices red\">\n<p>You cannot undo the deletion of a transfer instrument. If you want to rotate payout accounts, <a href=\"#add-a-payout-account\">add the new transfer instrument<\/a> first. Then, update the sweeps or on-demand transfers that used the old transfer instrument ID. Finally, after you verify the new transfer instrument is recieving funds, delete the old one.<\/p>\n<\/div>\n<h2>See also<\/h2>\n<ul>\n<li><a href=\"\/pt\/platforms\/manage-legal-entities\">Manage legal entities<\/a><\/li>\n<li><a href=\"\/pt\/platforms\/manage-balance-accounts\">Manage balance accounts<\/a><\/li>\n<li><a href=\"\/pt\/platforms\/payout-to-users\">Pay out to your users<\/a><\/li>\n<li><a href=\"\/pt\/platforms\/top-up-balance-account\">Top up balance accounts<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/pt\/platforms\/manage-transfer-instruments","articleFields":{"description":"Learn how to manage transfer instruments on your platform.","feedback_component":true,"cache_enable":false,"parameters":{"directoryPath":"\/platforms","model":"platform"},"filters_component":false,"last_edit_on":"28-03-2023 10:48"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/platforms\/manage-transfer-instruments","title":"Manage transfer instruments","content":"A transfer instrument is an API resource that represents an external bank account. You can use transfer instruments to send funds to and receive funds from bank accounts outside of your platform. These transfers can be made on-demand or generated by automated sweeps. \nThere are two main types of transfer instruments:\n\nYour users' bank accounts: These are the bank accounts of the account holders on your platform.\nYour payout accounts: These are your own company's bank accounts that you add to your platform. Adyen uses these accounts to settle funds to you. In an Adyen for Platforms integration, these are the transfer instruments that are connected to your liable account. \n\nThis page explains how to create, view, update, and delete transfer instruments for your users using the API, and how to manage your platform's payout accounts in the Customer Area.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAdyen for platforms\n\n\nAPI credential roles\nMake sure that you have a Legal Entity Management web service user with the following roles Manage LegalEntities via APIBalance Platform BCL Legal Entity role\n\n\nCustomer Area roles\nMake sure that you have the following role: Manage account holders &amp; legal entities\n\n\n\nManage transfer instruments with the API\nUse the  Legal Entity Management API to manage the transfer instruments that belong to you users or your platform. With the API you can:\n\nCreate a transfer instrument\nView transfer instruments\nUpdate a transfer instrument\nDelete a transfer instrument\n\nCreate a transfer instrument\nTo create a transfer instrument:\n\n\nMake a POST  \/transferInstruments request specifying the following: \n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n type\n\nSet to bankAccount.\n\n\n legalEntityId\n\nUnique identifier of the legal entity that has the contractual relationship with your platform and owns the bank account. For sole proprietorships, this is the legal entity ID of the individual owner.\n\n\n bankAccount\n\nObject that contains required information about the legal entity's bank account. The required parameters of this object depend on the location of your bank. Refer to  bankAccount\/accountIdentification in the API Explorer to confirm which parameters are valid for each location.\n\n\n\nHere is an example request to add a transfer instrument for a bank account in the US:\n\n\n\n\n\nRead the response. It contains the transfer instrument resource, identified by its unique id.\n\n\n\n\n\nLook for  problems in the response. The problems array contains information about which bank account verifications had issues. See Remediating actions for a list of possible remediating action codes and what they mean. \n\n\nThe result is a new transfer instrument with a unique ID. Use this ID to create a sweep, or as a target for a manual transfer.\nView transfer instruments\nTo view transfer instrument details:\n\n\nMake a GET  \/transferInstruments\/{id} specifying unique transferInstrumentId of the transfer instrument you want to view.\n\n\n\nPath parameter\nRequired\nDescription\n\n\n\n\n \/transferInstruments\/{id}\n\nThe unique identifier of the transfer instrument to retrieve.\n\n\n\n\n\n\n\n\nRead the response. A successful response, indicated by a 200 HTTP reponse code, contains the transfer instrument object with information about the bank account, such as the account number, account holder name, and verification status.\n\n\n\n\n\nUpdate a transfer instrument\nTo update a transfer instrument:\n\n\nMake a PATCH  \/transferInstruments\/{id} specifying the unique transferInstrumentId of the account you want to update. Only provide values for the fields you want to modify. If you are updating the bankAccount object, check  bankAccount\/accountIdentification in the API Explorer to confirm which parameters are valid for each location.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n \/transferInstruments\/{id}\n\nThe unique identifier of the transfer instrument to update.\n\n\n\nThe following example shows how to update the bank account with a new IBAN.\n\n\n\n\n\nRead the response. A successful response, indicated by a 200 http response code, contains the complete, updated transfer instrument object.\n\n\n\n\n\nLook for  problems in the response. The problems array contains information about which bank account verifications had issues. See Remediating actions for a list of possible remediating action codes and what they mean.\n\n\nThe result is an updated bank account that has the same transfer instrument ID. This means that sweeps and transfer requests that target the existing ID still work as expected.\nDelete a transfer instrument\nTo delete a transfer instrument, make a DELETE request to the  \/transferInstruments\/{id} endpoint.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\nid\n\nThe unique identifier of the transfer instrument to be deleted.\n\n\n\nHere is an example request to delete a transfer instrument:\n\n    \n\nYou cannot undo a delete request. If you need the same account added back, create a new transfer instrument. Any future manual transfers or automated sweeps that use the deleted ID will fail. \nPayout accounts\n\n\nYour platform's payout accounts are transfer instruments that are connected to your liable account. Adyen uses these payout accounts to settle funds to your company's bank accounts. This account is typically set up for you when you get started with Adyen.\nYou can create multiple payout accounts for your platform. When you need to make changes to your payout accounts, you can use the Customer Area or use the API. The Customer Area is only available to manage your platform's payout accounts, not your users' transfer instruments.\nAdd a payout account in the Customer Area\nYou can create payout accounts for your company in the Customer Area. Use this to create your first payout account, or add payout accounts in additional currencies. \nTo add a payout account: \n\nLog in to your Customer Area.\nNavigate to Finance &gt; Payout accounts\nSelect Add payout account.\nSelect your prefered verification method to either log in to your bank, or enter it manually alongside a bank statement\n\nAdyen makes the payout account available as soon as it passes verification. If you logged in with your bank, verification happens instantly. You can use the payout account when its status is valid.\nEdit or remove a payout account in the Customer Area\nTo manage your payout accounts:\n\nLog in to your Customer Area.\nNavigate to Finance &gt; Payout accounts\nFind the payout account you want to change and select the Remove or Edit from the options dropdown.\n\nEdits to transfer instruments take effect instantly. When you delete a transfer instrument, it stops recieving payouts. If you need restore the same account, create a new transfer instrument. Manual transfers or automated sweeps that use the deleted ID will begin to fail. \n\nYou cannot undo the deletion of a transfer instrument. If you want to rotate payout accounts, add the new transfer instrument first. Then, update the sweeps or on-demand transfers that used the old transfer instrument ID. Finally, after you verify the new transfer instrument is recieving funds, delete the old one.\n\nSee also\n\nManage legal entities\nManage balance accounts\nPay out to your users\nTop up balance accounts\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Platforms","lvl2":"Manage transfer instruments"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/platforms","lvl2":"\/pt\/platforms\/manage-transfer-instruments"},"levels":3,"category":"Platforms","category_color":"green","tags":["Manage","transfer","instruments"]}}