addBankDetails

Sets banking details for a given merchant, only the following field has to be provided:

  • bankDetailData

bankDetailData element fields

Some fields in the list below are flagged as optional. There are, however, some exceptions when an optional field may be mandatory to correctly process transactions with specific countries and/or currencies. For example, transactions involving  European countries that do not use the euro as a currency require specifying bankCity, bankHolderCity, and bankName, regardless of these countries being IBAN-compliant.
Fields Type Required Description

bankAccountNumber

Int (tick)

Holds the bank account number of the beneficiary merchant.

If the transaction includes bankIban, i.e. when the IBAN is provided, bankAccountNumber is an optional field. If there is a bankAccountNumber value, it is checked against the corresponding bankIban IBAN value.

If the transaction does not include bankIban, bankAccountNumber is a mandatory field.

bankBicSwift

Int (tick)

Holds the BIC code, a unique identifier for a bank.

The bankBicSwift field is mandatory for all transactions.

Its value must be longer than 6 characters.

bankCity Int (tick)

The bankCity field is mandatory for all non-EUR transactions and for all EUR transactions without an IBAN code.

The bankCity field is optional when the currency is EUR, or if the bank account belongs to the country where SEPA is available.

bankCode String (tick)

bankCode format is country-specific.

The bankCode field applies only to some specific countries. 

It is mandatory only for the following countries:

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

bankCountry

String (tick)

The bankCountry field is used to validate the required bank account information. It is mandatory when:

  • The transaction does not include IBAN.
  • If it is not possible to retrieve the country code from the IBAN code.

bankHolderCity

String (tick)

The bank holder identifies a natural person or a legal person, i.e. a specific individual or a business entity, owning a bank account.

The bankHolderCity field defines the city where the bank holder resides or is established.

The bankHolderCity field is optional when the currency is EUR, or if the bank account belongs to the country where SEPA is available.

The bankHolderCity field is mandatory for all EUR transactions without an IBAN code.

bankHolderCountry

String (tick)

The bank holder identifies a natural person or a legal person, i.e. a specific individual or a business entity, owning a bank account.

The bankHolderCountry field defines the country where the bank holder resides or is established.

The bankHolderCountry field is mandatory only for domestic transactions in the US.

bankHolderName

String (tick)

The bank holder identifies a natural person or a legal person, i.e. a specific individual or a business entity, owning a bank account.

The bankHolderName field defines the name of the individual or the entity that owns a bank account.

The bankHolderName field is mandatory for all transactions.

bankIban

Int (tick)

Defines the IBAN code of the bank account used for the transaction.

  • The bankIban field is mandatory for IBAN bank accounts only.
  • A list of IBAN-compliant countries is available on the SWIFT website.

bankName

String (tick)

Defines the name of the bank used for the transaction.

The bankName field is optional when the currency is EUR, or if the bank account belongs to the country where SEPA is available.

branchCode Int (tick)

branchCode format is country-specific.

The branchCode field applies only to some specific countries. It is mandatory only for the following countries:

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

checkCode (optional)

Int (tick) It corresponds to the check digits in an IBAN code.
If it is included in a transaction, its value is validated against the corresponding IBAN code.
This field is not mandatory, and it should not be included in transactions involving non-IBAN compliant countries.

merchantCode

String (tick)

The merchantCode specifies the name of the Merchant Account, and it is based on the tradingName.

This field is mandatory when calling addBankDetails.

Refer the given code examples.