Default icon

List of bank accounts

Get a list of the existing bank contracts for the specified merchant account.

Request parameters

To get a list of bank accounts, make a POST /listBankAccounts request specifying:

NameTypeRequiredDescription

accountKey

String
-x-

DEPRECATED
Not used anymore. Do not use.

merchantCode

String
-white_check_mark-

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

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Response parameters

The response contains a list of objects. Each object in the list holds data about one of the queried bank accounts.

Name Type
Returned by default
 Description
bankAccounts

List
-white_check_mark-

A container object for bank account data objects.

  • bankAccountDataSO

bankAccountsDeleteUnconfirmed

List
-x-

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

  • bankAccountDataSO

bankAccountsUpdateUnconfirmed

List
-x-

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

  • bankAccountDataSO

bankAccountDataSO

Class
-white_check_mark-

A container object for bank account data.

  • bankCity
  • bankCode
  • bankName
  • bic
  • branchCode
  • checkCode
  • countryCode
  • currency
  • foundationAccount
  • iban
  • number
  • owner
  • ownerCity

|-bankCity

String
-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.
|-bankCode

String
-x-

The code identifying the bank.
The field format is specific to the country/region.

bankCode is mandatory only for the following countries/regions:

  • Canada
  • Hong Kong
  • New Zealand
  • Singapore
  • Taiwan
-bankName

String
-x-

The name of the bank.

bankName is a mandatory field for:

  • All non-EUR transactions
|-bic

String
-x-

Business Identifier Code.
Unique identifier for the bank.

|-branchCode

String
-x-

The code identifying the bank branch office.
The field format is specific to the country/region.

branchCode is mandatory only for the following countries/regions:

  • Australia
  • Canada
  • Great Britain
  • Indonesia
  • Hong Kong
  • New Zealand
  • Singapore
  • South-Africa
  • Taiwan
  • United States
|-checkCode

String
-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/regions.

|-countryCode

String
-white_check_mark-

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.

|-currency

String
-white_check_mark-

The three-character ISO currency code.

|-foundationAccount

String
-white_check_mark-

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
-white_check_mark-

The International Bank Account Number.

|-number

String
-white_check_mark-

The bank account number.

|-owner

String
-white_check_mark-

Name of the bank account owner.

|-ownerCity

String
-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.

pspReference

String
-white_check_mark-

A reference to uniquely identify the request.

warnings

String
-x-

List containing one or more warning messages.
Returned when the request is not correctly processed.

errors

String
-x-

List containing one or more error messages.
Returned when the request fails.

Examples

Request

Response