Batch

  • 2 minute(s) read

Batch integration works based on the following principles:

  • It is semicolon separated CSV based, following the column headers that match our API request, where nested elements are flattened (Important: the file should NOT be comma separated, but semicolon separated.). For example:
 fundsOriginator.accountId;fundsOriginator.bankCountry
 FR234687134582354;FR

NOTE: Transactions have to be in sequential (sorted by timestamp, increasing) order to ensure Rules monitoring works as intended.

  • Mapping for arrays should be done as follows (when arrays contain data which consists of many fields):
masterData.accountHoldingPartyData.personalDetails.identityDocuments[0].id
masterData.accountHoldingPartyData.personalDetails.identityDocuments[1].id

or as follows (in case arrays contain simple strings):

masterData.accountHoldingPartyData.contactDetails.emailAddresses[0]
masterData.accountHoldingPartyData.contactDetails.emailAddresses[1]
  • The format expected for the field tenantProcessingTimestamp is the following: 2019-10-16T14:38:47.812
  • Batch files are picked up from your servers using SFTP.
    • access to your SFTP server should be restricted by IP, authentication should require username and password OR username and certificate
      • Steps
        • We provide you with our 4096 bit public key so that our private key is needed for authentication on top of username and password
        • We provide you with our IP-Rage from PRODUCTION environment (for TEST environment see here Common Concepts)
        • Set up your SFTP to authenticate via username, password and certificate OR restrict access to provided IPs.
    • On this SFTP server, we need to have full access and complete set of permissions, in order to read, rename or move files when needed.
    • We strongly recommend that files use stable prefixes (e.g transactions_YYYMMDD.zip, customers_YYYMMDD.zip).
    • The system can handle Zip archives as input. It should contain only one file and it has to have the same name as the archive.
    • The system can also handle encrypted zip with passwords. Supported encryption types: AES256, ZipCrypto.
    • When sending multiple files, each file needs to have clearly distinguishable prefixes.
    • There is a default speed limit of sending customer/transaction checks which is set to 10 TPS. However, the TPS limit will be set based on how many records the customer is planning on sending, at what time and when do they expect to see the cases in the case manager.
    • Our batch-service will scan your server every couple of minutes for a new file
      • Please provide a pattern that we can use to recognise the file. E.g. daily-batch.csv
    • When processing is finished we will rename by appending '_DONE' to the file name
      • optionally we can move the processed file to a folder

Please note:
The following are required fields:

  • tenantTransactionId
  • tenantProcessingTimestamp

Files should be sorted by tenantProcessingTimestamp, with the oldest file on top and the newest on the bottom.

You want to process different batch formats? Contact us.

Here is more extended example CSV file:

batch-example-full.csv