Transaction file

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

chevron-rightTransactions filehashtag
{
      "externalAccountTransactionId": "ID-1000",
      "externalAccountId": "IM-A-00023",
      "groupId": "1234",
      "transactionTypeCode": "CARD_PUR",
      "amount": {
        "amount": 1500,
        "currencyCode": "EUR"
      },
      "initialBalanceAmount": 2000,
      "valueDate": "2022-01-03",
      "postingDate": "2022-01-03",
      "details": "Card purchase - New laptop purchase",
      "source": {
        "sourceName": "string",
        "sourceRef": "string",
        "sourceLink": "string"
      },
      "merchantInfo": "{\"merchantName\":\"ComputerMARKT Gmbh\",\"merchantAddress\":\"Berlin, Germany\",\"terminalId\":\"54052345\",\"merchantType\":\"5541\",\"merchantTransactionId\":\"17e04828-6495-43f6-910b-5ec8cfa70873\"}",
      "metaInfo": "{\"campaignCode\":\"1979\",\"customerRating\":\"11.77\",\"customerGroup\":\"GOLD\",\"orderMarketingId\":\"xxx1234450000\"}",// if sourceName is PAYMENT then metaInfo should be in the following format. {"paymentResidencyCountryCode":"EE","intrabankPaymentSource":"ID-1000"}
      "contractSource": {
        "sourceName": "string",
        "sourceRef": "string",
        "sourceLink": "string",
        "contractNumber": "string"
      },
      "transactionDTime": "2023-02-17T10:52:11.121Z",
      "counterparty": {
        "name": "Peter Alexander Schmidt",
        "accountNumber": {
          "value": "DE89370400440532013000",
          "type": "IBAN"
        },
        "accountNumberCountryCode": "EE",
        "financialInstitutionId": {
          "value": "MAINDE2XXXX",
          "type": "BIC"
      },
      "endToEndId": "20210203-E000003",
      "paymentServiceProviderCode": "TUUM",
      "labels": [
        "SEPA_REGULAR",
        "ACC_VIRTUAL"
      ],
      "filingCode": "2022010300001011"
    }
}

When migrating account transactions, the following parameters are mandatory:

Parameter name
Description
Allowed values

externalAccountTransactionId

The unique account transaction reference from the external system.

The value is limited to the transaction id in the external system.

externalAccountId

The unique account reference from the external system.

The value is limited to the account id where the transaction occurred.

groupId

The unique identifier of related account transactions in the external system.

The value is limited to the groping id used in the external system.

transactionTypeCode

The transaction type code.

You can fetch the full list of all available transaction type codes by calling the find all transaction typesarrow-up-right endpoint.

amount:

  • amount

The transaction amount.

The value is limited to the transaction amount in the external system.

amount:

  • currencyCode

The transaction currency.

The currency code format: ISO 4217.

initialBalanceAmount

Initial balance amount.

The amount should be in the transaction amount currency.

valueDate

The date on which the operation actually carries out or is supposed to carry out in the account. It must be the same or earlier than the posting date.

The date format: YYYY-MM-DD.

postingDate

The current Tuum banking date when the account transaction was posted to the account API.

The date format: YYYY-MM-DD.

filingCode

A unique code used for all transactions.

The filling code format: Posting date in YYYYMMDD + 8 digit sequence (Add zero paddings to the left if needed). For example: if the posting date is 2023-01-11 and the sequence is 1011, the filing code will be 2023011100001011.

circle-info
  • The values for parameters of the source and contractSource objects are mandatory only when the corresponding objects are included in the JSON file.

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

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

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

Last updated

Was this helpful?