Account file

The JSON file for the account data is structured as follows:

Accounts file

 {
      "externalAccountId": "IM-A-00023",
      "externalPersonId": "IM-P-00023",
      "statusCode": "ACTIVE",
      "accountTypeCode": "CURRENCY",
      "activationDate": "2023-02-17",
      "externalMasterAccountId": "string",
      "overdraftAmount": {
        "amount": 1500,
        "currencyCode": "EUR"
      },
      "accountName": "My business account",
      "personName": "Peter Alexander Schmidt",
      "source": {
        "sourceName": "external",
        "sourceRef": "11",
        "sourceLink": "string"
      },
      "residencyCountryCode": "DE",
      "customerGroupCode": "GROUP_A",
      "priceListTypeCode": "STANDARD",
      "currencyCode": "EUR",
      "accountInterestRate": 0,
      "personTypeCode": "P",
      "intraOrgCode": "string",
      "accountTypeSetupCode": "string",
      "serviceProviderCode": "string",
      "interestMethodAssignmentCode": "string",
      "accountClassCode": "string",
      "accountNumbers": [ 
        {
          "accountNumber": {
            "value": "DE89370400440532013000",
            "type": "IBAN"
          },
          "countryCode": "DE",
          "financialInstitutionId": {
            "value": "MAINDE2XXXX",
            "type": "BIC"
          },
          "defaultCurrencyCode": "EUR"
        }
      ],
      "limits": [
        {
          "amount": {
            "amount": 1500,
            "currencyCode": "EUR"
          },
          "accountLimitTypeCode": "string"
        }
      ],
      "representatives": [
        {
          "externalPersonId": "IM-P-00024",
          "accountRightCode": "ALL",
          "limits": [
            {
              "amount": {
                "amount": 1500,
                "currencyCode": "EUR"
              },
              "accountLimitTypeCode": "string"
            }
          ]
        }
      ],
      "customFields": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    }
  ]

When migrating an account, the following parameters are mandatory:

Parameter name	Description	Allowed values
externalAccountId	The unique account reference from the external system.	The value is limited to the id of the account in the external system.
externalPersonId	The unique person reference from the external system.	The value is limited to the id of the account holder.
statusCode	The account status code.	The list of available values: ACTIVE, BLOCKED, CLOSED.
accountTypeCode	The account type.	The list of available values: CURRENCY, INTERNAL, SAVING, SHADOW, VIRTUAL.
activationDate	The account activation date.	The date format: YYYY-MM-DD.
interestMethodAssignmentCode	The interest method assignment code.	Required, if the accountTypeCode has interest.
accountNumber: value	The account number.	The value is limited to the account number in the external system.
accountNumber: type	The account number type.	The list of available values: IBAN - International Bank Account Number contains the account number, bank and branch information and country code. BBAN - Basic Bank Account Number. It represents a country-specific bank account number. SWIFT - a code identifying a specific bank.
countryCode	The account country code.	The country code format: ISO 3166 (alpha-2).
financialInstitutionId: value	The identification number of the financial institution.	The value is limited to the financial institution id in the external system.
financialInstitutionId: type	The financial institution type.	The list of available values: BIC - an eight-digit number referred to as the Bank Identifier Code. SORT_CODE - a six-digit number referred to as the domestic bank code. BANK_CODE - a numerical code assigned to the financial institution by a central bank. ABA_CODE - a nine-digit number used by banks to identify financial institutions within the United States.
defaultCurrencyCode	The account default currency.	The currency format: ISO 4217.

• The values for parameters of the overdraftAmount, source, limits, and representatives objects are mandatory only when the corresponding objects are included in the Accounts file.

• To find the description of the non-mandatory parameters, refer to the account object parameters.

Attach the account file to the request body of the data import API call as shown below.

--form 'accounts=@"/path/to/file"