--- title: "Update a transfer instrument" method: PATCH path: "/transferInstruments/{id}" tags: ["Transfer instruments"] --- # Update a transfer instrument `PATCH /transferInstruments/{id}` Updates a transfer instrument. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds. ## Path parameters - `id` string, required ## Headers - `x-requested-verification-code` string ## Request body - TransferInstrumentInfo - `bankAccount` BankAccountInfo, required - `accountIdentification` union — Identification of the bank account. - object - `accountNumber` string, required — The bank account number, without separators or whitespace. - `bsbCode` string, required — The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. - `type` 'auLocal', required — **auLocal** - object - `accountNumber` string, required — The 5- to 12-digit bank account number, without separators or whitespace. - `accountType` 'checking' | 'savings' — The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. - `institutionNumber` string, required — The 3-digit institution number, without separators or whitespace. - `transitNumber` string, required — The 5-digit transit number, without separators or whitespace. - `type` 'caLocal', required — **caLocal** - object - `accountNumber` string, required — The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) - `bankCode` string, required — The 4-digit bank code (Kód banky), without separators or whitespace. - `type` 'czLocal', required — **czLocal** - object - `accountNumber` string, required — The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). - `bankCode` string, required — The 4-digit bank code (Registreringsnummer) (without separators or whitespace). - `type` 'dkLocal', required — **dkLocal** - object - `accountNumber` string, required — The 9- to 17-digit bank account number, without separators or whitespace. Starts with the 3-digit branch code. - `clearingCode` string, required — The 3-digit clearing code, without separators or whitespace. - `type` 'hkLocal', required — **hkLocal** - object - `accountNumber` string, required — The 24-digit bank account number, without separators or whitespace. - `type` 'huLocal', required — **huLocal** - object - `bic` string — The bank's 8- or 11-character BIC or SWIFT code. - `iban` string, required — The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. - `type` 'iban', required — **iban** - object - `accountNumber` string, required — The 11-digit bank account number, without separators or whitespace. - `type` 'noLocal', required — **noLocal** - object - `accountNumber` string, required — The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. - `type` 'nzLocal', required — **nzLocal** - object - `accountNumber` string, required — The bank account number, without separators or whitespace. The length and format depends on the bank or country. - `additionalBankIdentification` AdditionalBankIdentification - `code` string — The value of the additional bank identification. - `type` 'auBsbCode' | 'caRoutingNumber' | 'gbSortCode' | 'usRoutingNumber' — The type of additional bank identification, depending on the country. Possible values: * **auBsbCode**: The 6-digit [Australian Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or spaces. * **caRoutingNumber**: The 9-digit [Canadian routing number](https://en.wikipedia.org/wiki/Routing_number_(Canada)), in EFT format, without separators or spaces. * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'numberAndBic', required — **numberAndBic** - object - `accountNumber` string, required — The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. - `type` 'plLocal', required — **plLocal** - object - `accountNumber` string, required — The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. - `clearingNumber` string, required — The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. - `type` 'seLocal', required — **seLocal** - object - `accountNumber` string, required — The 4- to 19-digit bank account number, without separators or whitespace. - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'sgLocal' — **sgLocal** - object - `accountNumber` string, required — The 8-digit bank account number, without separators or whitespace. - `sortCode` string, required — The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. - `type` 'ukLocal', required — **ukLocal** - object - `accountNumber` string, required — The bank account number, without separators or whitespace. - `accountType` 'checking' | 'savings' — The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. - `routingNumber` string, required — The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. - `type` 'usLocal', required — **usLocal** - `accountType` string — The type of bank account. - `bankName` string — The name of the banking institution where the bank account is held. - `countryCode` string — The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the bank account is registered. For example, **NL**. - `trustedSource` boolean — Identifies if the bank account was created through [instant bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding). - `legalEntityId` string, required — The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) that owns the transfer instrument. - `type` 'bankAccount' | 'recurringDetail', required — The type of transfer instrument. Possible value: **bankAccount**. ## Response `200` OK - the request has succeeded. - TransferInstrument - `bankAccount` BankAccountInfo, required - `accountIdentification` union — Identification of the bank account. - object - `accountNumber` string, required — The bank account number, without separators or whitespace. - `bsbCode` string, required — The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. - `type` 'auLocal', required — **auLocal** - object - `accountNumber` string, required — The 5- to 12-digit bank account number, without separators or whitespace. - `accountType` 'checking' | 'savings' — The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. - `institutionNumber` string, required — The 3-digit institution number, without separators or whitespace. - `transitNumber` string, required — The 5-digit transit number, without separators or whitespace. - `type` 'caLocal', required — **caLocal** - object - `accountNumber` string, required — The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) - `bankCode` string, required — The 4-digit bank code (Kód banky), without separators or whitespace. - `type` 'czLocal', required — **czLocal** - object - `accountNumber` string, required — The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). - `bankCode` string, required — The 4-digit bank code (Registreringsnummer) (without separators or whitespace). - `type` 'dkLocal', required — **dkLocal** - object - `accountNumber` string, required — The 9- to 17-digit bank account number, without separators or whitespace. Starts with the 3-digit branch code. - `clearingCode` string, required — The 3-digit clearing code, without separators or whitespace. - `type` 'hkLocal', required — **hkLocal** - object - `accountNumber` string, required — The 24-digit bank account number, without separators or whitespace. - `type` 'huLocal', required — **huLocal** - object - `bic` string — The bank's 8- or 11-character BIC or SWIFT code. - `iban` string, required — The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. - `type` 'iban', required — **iban** - object - `accountNumber` string, required — The 11-digit bank account number, without separators or whitespace. - `type` 'noLocal', required — **noLocal** - object - `accountNumber` string, required — The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. - `type` 'nzLocal', required — **nzLocal** - object - `accountNumber` string, required — The bank account number, without separators or whitespace. The length and format depends on the bank or country. - `additionalBankIdentification` AdditionalBankIdentification - `code` string — The value of the additional bank identification. - `type` 'auBsbCode' | 'caRoutingNumber' | 'gbSortCode' | 'usRoutingNumber' — The type of additional bank identification, depending on the country. Possible values: * **auBsbCode**: The 6-digit [Australian Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or spaces. * **caRoutingNumber**: The 9-digit [Canadian routing number](https://en.wikipedia.org/wiki/Routing_number_(Canada)), in EFT format, without separators or spaces. * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'numberAndBic', required — **numberAndBic** - object - `accountNumber` string, required — The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. - `type` 'plLocal', required — **plLocal** - object - `accountNumber` string, required — The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. - `clearingNumber` string, required — The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. - `type` 'seLocal', required — **seLocal** - object - `accountNumber` string, required — The 4- to 19-digit bank account number, without separators or whitespace. - `bic` string, required — The bank's 8- or 11-character BIC or SWIFT code. - `type` 'sgLocal' — **sgLocal** - object - `accountNumber` string, required — The 8-digit bank account number, without separators or whitespace. - `sortCode` string, required — The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. - `type` 'ukLocal', required — **ukLocal** - object - `accountNumber` string, required — The bank account number, without separators or whitespace. - `accountType` 'checking' | 'savings' — The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. - `routingNumber` string, required — The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. - `type` 'usLocal', required — **usLocal** - `accountType` string — The type of bank account. - `bankName` string — The name of the banking institution where the bank account is held. - `countryCode` string — The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the bank account is registered. For example, **NL**. - `trustedSource` boolean — Identifies if the bank account was created through [instant bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding). - `capabilities` object — List of capabilities for this transfer instrument. - `documentDetails` DocumentReference[] — List of documents uploaded for the transfer instrument. - `active` boolean — Identifies whether the document is active and used for checks. - `description` string — Your description for the document. - `fileName` string — Document name. - `id` string — The unique identifier of the resource. - `modificationDate` string, date-time — The modification date of the document. - `pages` DocumentPage[] — List of document pages - `pageName` string - `pageNumber` integer - `type` 'BACK' | 'FRONT' | 'UNDEFINED' - `type` string — Type of document, used when providing an ID number or uploading a document. - `id` string, required — The unique identifier of the transfer instrument. - `legalEntityId` string, required — The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) that owns the transfer instrument. - `problems` CapabilityProblem[] — The verification errors related to capabilities for this transfer instrument. - `entity` CapabilityProblemEntity - `documents` string[] — List of document IDs corresponding to the verification errors from capabilities. - `id` string - `owner` CapabilityProblemEntityRecursive - `documents` string[] — List of document IDs corresponding to the verification errors from capabilities. - `id` string - `type` 'BankAccount' | 'Document' | 'LegalEntity' | 'product' - `type` 'BankAccount' | 'Document' | 'LegalEntity' | 'product' - `verificationErrors` VerificationError[] - `capabilities` string[] — Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. - `code` string — The general error code. - `message` string — The general error message. - `remediatingActions` RemediatingAction[] — An object containing possible solutions to fix a verification error. - `code` string - `message` string - `subErrors` VerificationErrorRecursive[] — An array containing more granular information about the cause of the verification error. - `capabilities` string[] — Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. - `code` string — The general error code. - `message` string — The general error message. - `type` 'dataMissing' | 'dataReview' | 'invalidInput' | 'pendingStatus' | 'rejected' — The type of error. Possible values: * **invalidInput** * **dataMissing** * **pendingStatus** * **rejected** * **dataReview** - `remediatingActions` RemediatingAction[] — An object containing possible solutions to fix a verification error. - `code` string - `message` string - `type` 'dataMissing' | 'dataReview' | 'invalidInput' | 'pendingStatus' | 'rejected' — The type of error. Possible values: * **invalidInput** * **dataMissing** * **pendingStatus** * **rejected** * **dataReview** - `type` 'bankAccount' | 'recurringDetail', required — The type of transfer instrument. Possible value: **bankAccount**. ## Other responses - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/legal-entity-management-api.md) · [All operations](https://skmtc.net/adyen/apis/legal-entity-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/legal-entity-management-api/versions/2ae704e1705b/schema)