listBankAccounts response

listBankAccounts returns a list of objects. Each object in the list holds data about one of the queried bank accounts.

  Type Returned by default Description
bankAccounts List (tick)
A container object for bank account data objects.
  • bankAccountDataSO
bankAccountsDeleteUnconfirmed List (error)
A container object for bank account data objects. It holds non-confirmed bank account entries marked for deletion.
  • bankAccountDataSO
bankAccountsUpdateUnconfirmed List (error)
A container object for bank account data objects. It holds non-confirmed bank account entries marked for update.
  • bankAccountDataSO
bankAccountDataSO Class (tick)
A container object for bank account data.
  • bankCity
  • bankCode
  • bankName
  • bic
  • branchCode
  • checkCode
  • countryCode
  • currency
  • foundationAccount
  • iban
  • number
  • owner
  • ownerCity
bankCity String (error)
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.
bankCode String (error)
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
bankName String (error)
The name of the bank.

bankName is a mandatory field for:

  • All non-EUR transactions

bic

String (error)
Business Identifier Code.
Unique identifier for the bank.
branchCode String (error)
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
checkCode String (error)
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.
countryCode String (tick)

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 web site.

currency String (tick)
The three-character ISO currency code.
foundationAccount String (tick)
The foundation account number (FAN).
A unique identifier.
This is a non editable, read-only field.
It is relevant only in the call response.
iban String (tick)
number String (tick)
The bank account number.
owner String (tick)
Name of the bank account owner.
ownerCity String (error)
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.

pspReference String (tick)
A reference to uniquely identify the request.
warnings String (error)
List containing one or more warning messages.
Returned when the request is not correctly processed.
errors String (error)
List containing one or more error messages.
Returned when the request fails.