{"title":"List of bank accounts","category":"default","creationDate":1776961629,"content":"

Request parameters<\/h2>\n

To get a list of bank accounts, make a POST \/listBankAccounts<\/code> request specifying: <\/p>\n\n \n \n
Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>\n
\n

accountKey<\/code><\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

DEPRECATED
\nNot used anymore. Do not use.<\/p>\n<\/td>\n <\/tr>\n

\n

merchantCode<\/code><\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

A merchant code string holds a value to identify a merchant.<\/p>\n

Format:<\/p>\n

    \n
  • Either: MerchantAccount.Merchant_Code<\/code><\/li>\n
  • Or: Merchant_Code<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n<\/tbody><\/table>\n

    Response parameters<\/h2>\n

    The response contains a list of objects. Each object in the list holds data about one of the queried bank accounts.<\/p>\n\n\n \n \n
    Name<\/th>\n Type<\/th>\n
    Returned by default<\/center><\/th>\n
    		Description<\/th>\n <\/tr>\n
    bankAccounts<\/code><\/td>\n

    List<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A container object for bank account data objects.

    • bankAccountDataSO<\/code><\/li><\/ul><\/p>\n<\/td><\/tr>\n
    bankAccountsDeleteUnconfirmed<\/code><\/td>\n

    List<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    A container object for bank account data objects. It holds non-confirmed bank account entries marked for deletion.

    • bankAccountDataSO<\/code><\/li><\/ul><\/p>\n<\/td><\/tr>\n
    bankAccountsUpdateUnconfirmed<\/code><\/td>\n

    List<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    A container object for bank account data objects. It holds non-confirmed bank account entries marked for update.

    • bankAccountDataSO<\/code><\/li><\/ul><\/p>\n<\/td><\/tr>\n
    bankAccountDataSO<\/code><\/td>\n

    Class<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A container object for bank account data.

    • bankCity<\/code><\/li>
    • bankCode<\/code><\/li>
    • bankName<\/code><\/li>
    • bic<\/code><\/li>
    • branchCode<\/code><\/li>
    • checkCode<\/code><\/li>
    • countryCode<\/code><\/li>
    • currency<\/code><\/li>
    • foundationAccount<\/code><\/li>
    • iban<\/code><\/li>
    • number<\/code><\/li>
    • owner<\/code><\/li>
    • ownerCity<\/code><\/li><\/ul><\/p>\n<\/td><\/tr>\n
    <\/td>|-bankCity<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    The (main) city the bank operates from.
    \nbankCity<\/code>\u00a0is an optional field for EUR transactions.``<\/p>\n

    \n

    bankCity<\/code> is a mandatory<\/em> field for:<\/p>\n

      \n
    • All non-EUR transactions<\/li>\n
    • All EUR transactions without an IBAN code.<\/li>\n<\/ul>\n<\/div><\/div>\n<\/td><\/tr>\n
    <\/td>|-bankCode<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    The code identifying the bank.
    \nThe field format is specific to the country\/region. <\/p>\n

    \n

    bankCode<\/code> is mandatory only<\/em> for the following countries\/regions:<\/p>\n

      \n
    • Canada<\/li>\n
    • Hong Kong<\/li>\n
    • New Zealand<\/li>\n
    • Singapore<\/li>\n
    • Taiwan<\/li>\n<\/ul>\n<\/div><\/div>\n<\/td><\/tr>\n
    <\/td>-bankName<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    The name of the bank.<\/p>\n

    \n

    bankName<\/code> is a mandatory<\/em> field for:<\/p>\n

      \n
    • All non-EUR transactions<\/li>\n<\/ul>\n<\/div><\/div>\n<\/td><\/tr>\n
    <\/td>|-bic<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    Business Identifier Code<\/a>.
    \nUnique identifier for the bank.<\/p>\n<\/td><\/tr>\n

    <\/td>|-branchCode<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    The code identifying the bank branch office.
    \nThe field format is specific to the country\/region.<\/p>\n

    \n

    branchCode<\/code>\u00a0is mandatory only<\/em> for the following countries\/regions:<\/p>\n

      \n
    • Australia<\/li>\n
    • Canada<\/li>\n
    • Great Britain<\/li>\n
    • Indonesia<\/li>\n
    • Hong Kong<\/li>\n
    • New Zealand<\/li>\n
    • Singapore<\/li>\n
    • South-Africa<\/li>\n
    • Taiwan<\/li>\n
    • United States<\/li>\n<\/ul>\n<\/div><\/div>\n<\/td><\/tr>\n
    <\/td>|-checkCode<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    Code check. It corresponds to checking digits in an IBAN code.
    \nIf it is included in a transaction, its value is validated against the corresponding IBAN code.
    \ncheckCode<\/code>\u00a0should never be included in transactions involving non-IBAN compliant countries\/regions.<\/p>\n<\/td><\/tr>\n

    <\/td>|-countryCode<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    The country<\/code> value format needs to adhere to the ISO 3166-1 alpha-2<\/a> standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes<\/a> on the ISO website.<\/p>\n<\/td><\/tr>\n

    <\/td>|-currency<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    The three-character ISO currency code<\/a>.<\/p>\n<\/td><\/tr>\n

    <\/td>|-foundationAccount<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    The foundation account number (FAN).
    \nA unique identifier.
    \nThis is a non editable, read-only field.
    \nIt is relevant only in the call response.<\/p>\n<\/td><\/tr>\n

    <\/td>|-iban<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    The International Bank Account Number<\/a>.<\/p>\n<\/td><\/tr>\n

    <\/td>|-number<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    The bank account<\/a> number.<\/p>\n<\/td><\/tr>\n

    <\/td>|-owner<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    Name of the bank account owner.<\/p>\n<\/td><\/tr>\n

    <\/td>|-ownerCity<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    Name of the city where the bank account holder resides.
    \nThis is a mandatory field when:<\/p>\n

      \n
    • \n

      The transaction does not include an IBAN.<\/p>\n<\/li>\n

    • \n

      The transaction is non-EUR.<\/p>\n<\/li>\n<\/ul>\n<\/td><\/tr>\n

    pspReference<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A reference to uniquely identify the request.<\/p>\n<\/td><\/tr>\n

    warnings<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more warning messages.
    \nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr>\n

    errors<\/code><\/td>\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more error messages.
    \nReturned when the request fails.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

    Examples<\/h2>\n

    Request<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response<\/h3>\n
    \n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/listbankaccounts","articleFields":{"id":"25134970","type":"page","description":"Get a list of the existing bank contracts\u00a0for the specified merchant account.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/listbankaccounts","title":"List of bank accounts","content":"Request parameters\nTo get a list of bank accounts, make a POST \/listBankAccounts request specifying: \nNameTypeRequiredDescription\n\n \n \naccountKey\n\n \nString\n\n \n\n\n \nDEPRECATED\nNot used anymore. Do not use.\n\n \n \n \nmerchantCode\n\n \nString\n\n \n\n\n \nA merchant code string holds a value to identify a merchant.\nFormat:\n\nEither: MerchantAccount.Merchant_Code\nOr: Merchant_Code\n\n\n \n\nResponse parameters\nThe response contains a list of objects. Each object in the list holds data about one of the queried bank accounts.\n\n \n \n \n Name\n Type\n Returned by default\n Description\n \n bankAccounts\nList\n\n\n\nA container object for bank account data objects.bankAccountDataSO\n\n bankAccountsDeleteUnconfirmed\nList\n\n\n\nA container object for bank account data objects. It holds non-confirmed bank account entries marked for deletion.bankAccountDataSO\n\n bankAccountsUpdateUnconfirmed\nList\n\n\n\nA container object for bank account data objects. It holds non-confirmed bank account entries marked for update.bankAccountDataSO\n\n bankAccountDataSO\nClass\n\n\n\nA container object for bank account data.bankCitybankCodebankNamebicbranchCodecheckCodecountryCodecurrencyfoundationAccountibannumberownerownerCity\n\n |-bankCity\nString\n\n\n\nThe (main) city the bank operates from.\nbankCity\u00a0is an optional field for EUR transactions.``\n\nbankCity is a mandatory field for:\n\nAll non-EUR transactions\nAll EUR transactions without an IBAN code.\n\n\n\n |-bankCode\nString\n\n\n\nThe code identifying the bank.\nThe field format is specific to the country\/region. \n\nbankCode is mandatory only for the following countries\/regions:\n\nCanada\nHong Kong\nNew Zealand\nSingapore\nTaiwan\n\n\n\n -bankName\nString\n\n\n\nThe name of the bank.\n\nbankName is a mandatory field for:\n\nAll non-EUR transactions\n\n\n\n |-bic\nString\n\n\n\nBusiness Identifier Code.\nUnique identifier for the bank.\n\n |-branchCode\nString\n\n\n\nThe code identifying the bank branch office.\nThe field format is specific to the country\/region.\n\nbranchCode\u00a0is mandatory only for the following countries\/regions:\n\nAustralia\nCanada\nGreat Britain\nIndonesia\nHong Kong\nNew Zealand\nSingapore\nSouth-Africa\nTaiwan\nUnited States\n\n\n\n |-checkCode\nString\n\n\n\nCode check. It corresponds to checking digits in an IBAN code.\nIf it is included in a transaction, its value is validated against the corresponding IBAN code.\ncheckCode\u00a0should never be included in transactions involving non-IBAN compliant countries\/regions.\n\n |-countryCode\nString\n\n\n\nThe country value format needs to adhere to the ISO 3166-1 alpha-2 standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes on the ISO website.\n\n |-currency\nString\n\n\n\nThe three-character ISO currency code.\n\n |-foundationAccount\nString\n\n\n\nThe foundation account number (FAN).\nA unique identifier.\nThis is a non editable, read-only field.\nIt is relevant only in the call response.\n\n |-iban\nString\n\n\n\nThe International Bank Account Number.\n\n |-number\nString\n\n\n\nThe bank account number.\n\n |-owner\nString\n\n\n\nName of the bank account owner.\n\n |-ownerCity\nString\n\n\n\nName of the city where the bank account holder resides.\nThis is a mandatory field when:\n\n\nThe transaction does not include an IBAN.\n\n\nThe transaction is non-EUR.\n\n\n\n pspReference\nString\n\n\n\nA reference to uniquely identify the request.\n\n warnings\nString\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\n errors\nString\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage bank accounts and payouts","lvl3":"List of bank accounts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts","lvl3":"\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/listbankaccounts"},"levels":4,"category":"","category_color":"","tags":["accounts"]},"articleFiles":{"976426678.json":"

    976426678.json<\/p>","1881892202.json":"

    1881892202.json<\/p>"}}