Are you looking for test card numbers?

Would you like to contact support?

Default icon

updateBankAccount

Update the information of an existing bank account at merchant level.

Use the updateBankAccount endpoint to update or delete existing bank account information. The information is updated or deleted based on the data that you submit. For example:

Type of data Operation
New data Update operation. The new data replace the corresponding existing data.
Empty string Delete operation. The empty string replaces the corresponding existing data, i.e. the information on record is deleted.
Same value or no new value No change. The corresponding existing data is kept.
Any optional fields not included in the update No change. The corresponding existing data is kept.

The following fields require a 4-eye policy review:

  • bankAccountsDeleteUnconfirmed
  • bankAccountsUpdateUnconfirmed

A bank account is defined by the  merchantCode and the currency. There can't be multiple bank accounts with the same currency set up. These are the only required fields for an update. If a value for a field is not set, the old value is retained.

Request parameters

To update bank account information for a merchant account, make a POST /updateBankAccount request specifying:

Name Type
Required
Description
accountKeyString
-x-
DEPRECATED
Not used anymore. Do not use.
merchantCodeString
-white_check_mark-

A merchant code string holds a value to identify a merchant. Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code
bankAccountDataClass
-white_check_mark-
A container object for bank account data.
  • bankCity
  • bankCode
  • bankName
  • bic
  • branchCode
  • checkCode
  • countryCode
  • currency
  • foundationAccount
  • iban
  • number
  • owner
  • ownerCity
|-bankCityString
-x-
The (main) city the bank operates from.
bankCity is an optional field for EUR transactions.``
bankCity is a mandatory field for:
  • All non-EUR transactions
  • All EUR transactions without an IBAN code.
|-bankCodeString
-x-
The code identifying the bank.
The field format is country-specific.
bankCode is mandatory only for the following countries:
  • Canada
  • Hong Kong
  • New Zealand
  • Singapore
  • Taiwan
|-bankNameString
-x-
The name of the bank.
bankName is a mandatory field for:
  • All non-EUR transactions
|-bicString
-x-
Business Identifier Code.
Unique identifier for the bank.
|-branchCodeString
-x-
The code identifying the bank branch office.
The field format is country-specific.
branchCode is mandatory only for the following countries:
  • Australia
  • Canada
  • Great Britain
  • Indonesia
  • Hong Kong
  • New Zealand
  • Singapore
  • South-Africa
  • Taiwan
  • United States
|-checkCodeString
-x-
Code check. It corresponds to checking digits in an IBAN code.
If it is included in a transaction, its value is validated against the corresponding IBAN code.
checkCode should never be included in transactions involving non-IBAN compliant countries.
|-countryCodeString
-x-

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO website.

This field is mandatory in the following cases:
  • The transaction does not include an IBAN. 
  • If it is not possible to retrieve the country code from the IBAN code.
|-currencyString
-white_check_mark-
The three-character ISO currency code.
This is a non editable, read-only field.
|-foundationAccountString
-x-
The foundation account number (FAN).
A unique identifier.
This is a non editable, read-only field.
It is relevant only in the call response.
|-ibanString
-x-
The International Bank Account Number.
|-numberString
-x-
The bank account number.
|-ownerString
-x-
Name of the bank account owner.
|-ownerCityString
-x-
Name of the city where the bank account holder resides.
This is a mandatory field when:
  • The transaction does not include an IBAN.
  • The transaction is non-EUR.

Response parameters

If there are no errors in the request, the call returns a pspReference.If any issues occur during the process, the call returns one or more warning or error messages.

NameTypeReturned by defaultDescription
pspReferenceString
-white_check_mark-
A reference to uniquely identify the request.
warningsString
-x-

Warning message about problems encountered while trying to update the specified bank account details.
Returned when the update operation does not work as expected.

errorsString
-x-

Error message(s) about problems encountered while trying to update the specified bank account details.
Returned when the update operation fails.

Examples

Request

{  
   "merchantCode":"TestMerchant",
   "bankAccountData":{  
      "bic":"RABONL2U",
      "countryCode":"NL",
      "currency":"EUR",
      "iban":"NL39RABO123456789",
      "number":"123456789",
      "owner":"TestOwnerEUR"
   }
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <updateBankAccount xmlns="http://caaccount.services.adyen.com">
      <request>
        <bankAccountData>
          <bic>RABONL2U</bic>
          <countryCode xmlns="http://serviceobjects.caaccount.services.adyen.com">NL</countryCode>
          <currency xmlns="http://serviceobjects.caaccount.services.adyen.com">EUR</currency>
          <iban xmlns="http://serviceobjects.caaccount.services.adyen.com">NL39RABO123456789</iban>
          <number xmlns="http://serviceobjects.caaccount.services.adyen.com">123456789</number>
          <owner xmlns="http://serviceobjects.caaccount.services.adyen.com">TestOwnerEUR</owner>
        </bankAccountData>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </updateBankAccount>
  </soap:Body>
</soap:Envelope>

Response

{  
   "pspReference":"9914526949630181"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:updateBankAccountResponse>
      <ns0:response>
        <ns0:pspReference>9914526949630181</ns0:pspReference>
      </ns0:response>
    </ns0:updateBankAccountResponse>
  </soap:Body>
</soap:Envelope> 

Response in case of an error

{  
  "errors":  {  
    "string":"validation errors: branchCode=not present, iban=not valid for DE"
  },
  "pspReference":"9914140757570032"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:updateBankAccountResponse>
      <ns0:response>
        <ns0:errors>
          <ns0:string>validation errors: branchCode=not present, iban=not valid for DE</ns0:string>
        </ns0:errors>
        <ns0:pspReference>9914140757570032</ns0:pspReference>
      </ns0:response>
    </ns0:updateBankAccountResponse>
  </soap:Body>
</soap:Envelope>