Curate Bank Account

Curates the given bank account.

The BankAccount that is sent in the request has to be uniquely identifiable. Minimal sets of attributes that identify a BankAccount are:

  1. Only the IBAN (= internationalBankAccountIdentifier):
    {
      "bankAccount": {
        "internationalBankAccountIdentifier": "CH8800781619278412000"
      }
    }
    
  2. The bank account number (= nationalBankAccountIdentifier), bank code/number (= bank.nationalBankIdentifier) and bank country code (= bank.address.country.shortName):
    {
      "bankAccount": {
        "nationalBankAccountIdentifier": "619278412000",
        "bank" : {
          "nationalBankIdentifier": "00781",
          "address": {
            "country": {
              "shortName": "CH"
            }
          }
        }
      }
    }
    
  3. The bank account number (= nationalBankAccountIdentifier), bank code/number (= bank.nationalBankIdentifier) and the BIC (= internationalBankIdentifier):
    {
      "bankAccount": {
        "nationalBankAccountIdentifier": "619278412000",
        "bank" : {
          "nationalBankIdentifier": "00781",
          "internationalBankIdentifier": "KBSGCH22XXX"
        }
      }
    }
    

If IBAN is not present in the request it will be generated only if there is sufficient data:

  • countryCode
  • internationalBankIdentifier
  • nationalBankAccountIdentifier

Or

  • internationalBankIdentifier
  • nationalBankIdentifier
  • nationalBankAccountIdentifier

For the following countries the generation of the internationalBankAccountIdentifier (IBAN) is NOT supported in the current version:

AL, BA, BE, BG, BI, BR, DJ, EE, EG, ES, FI, FO, FR, HU, IS, IT, LY, MC, ME, MK, MR, NO, PL, PT, RS, SC, SD, SI, SM, TL, TR

The response will always contain the original BankAccount provided in the request and a curated version of it. For example: { "originalBankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000" }, "curatedBankAccount": { "internationalBankAccountIdentifier": "CH8800781619278412000" "nationalBankAccountIdentifier": "619278412000", "bank" : { "nationalBankIdentifier": "00781", "address": { "country": { "shortName": "CH" } } } } }

If the given request does not provide one of the combinations of attributes described above, an ApiError will be returned: { "timestamp": "...", "message": "...", "error": "Bad Request", "path": "...", "status": 400 } Message contains concatenated descriptions of all errors that occurred in the request.

SecurityapiKey
Request
Request Body schema: application/json
required
required
object (BankAccountCuration)

A request to curate a BankAccount.

featuresOff
Array of strings (BankAccountCurationFeatureParam)

Feature(s) to be used during curation:

  • REMOVE_INVALID_VALUES - Removes all invalid values (e.g. internationalBankIdentifier) during curation. By default, activated.
Items Value: Description
REMOVE_INVALID_VALUES

Removes all invalid values (e.g. internationalBankIdentifier) during curation.

Example: ["REMOVE_INVALID_VALUES"]
featuresOn
Array of strings (BankAccountCurationFeatureParam)

Feature(s) to be used during curation:

  • REMOVE_INVALID_VALUES - Removes all invalid values (e.g. internationalBankIdentifier) during curation. By default, activated.
Items Value: Description
REMOVE_INVALID_VALUES

Removes all invalid values (e.g. internationalBankIdentifier) during curation.

Example: ["REMOVE_INVALID_VALUES"]
Responses
200

OK

400

Bad Request

401

Unauthorized

post/bankaccounts/curate
Request samples
application/json
{
  • "bankAccount": {
    },
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
application/json
{
  • "originalBankAccount": {
    },
  • "curatedBankAccount": {
    }
}