Registers a new bank account related to a merchant.

post/bank-accounts

Request

Base URL
https://api.test.kalixa.com/payment-service/v6
URL
https://api.test.kalixa.com/payment-service/v6/bank-accounts
Auth
HTTP basic

Request body

bankNamestring required

The name of the bank at which this account is held. Used for settlement purposes.

accountNumberstring

The account number of the bank account. Should only be provided if the account does not have an IBAN. Used for settlement purposes if no IBAN provided.

bankCodestring

The bank code of the bank at which this account is held. Should only be provided if the account does not have a BIC code. Used for settlement purposes if no BIC provided.

countryCodestring required

The country code for the country in which this account was created as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

currencyCodestring required

The currency code for the currency in which the account is held as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).

holderNamestring required

The name of the person that is registered as the account holder.

ibanstring

The IBAN of the account. Used for settlement purposes.

bicstring

The BIC code of the bank at which this account is held.

merchantIdstring required

The id of the merchant to which this bank account should be associated with. Used for associating the company with the merchant.

Example request

{
  "bankName": "Erste Bank",
  "countryCode": "AT",
  "currencyCode": "EUR",
  "holderName": "Max Mayer",
  "iban": "AT990000111122223333",
  "bic": "DABAIE2D",
  "merchantId": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
}

Response

Successful operation

idstring

The server-generated id of the bank account which was registered or returned. Used for identifying the bank account in other methods e.g. getBankAccount.

bankNamestring