Batch integration

New
  • 1 minute(s) read
Prev Next

Batch integration allows you to submit large volumes of Customer or transaction data via CSV files. The service is designed around the following key principles:

File format

  • Files must be semicolon-separated CSVs (;), not comma-separated

  • Column headers must match our API request structure

  • Nested elements must be flattened

 fundsOriginator.accountId;fundsOriginator.bankCountry
 FR234687134582354;FR

Transactions must be sorted sequentially by timestamp (ascending order) to ensure that Rules monitoring works correctly.

Handling arrays

  • Arrays with multiple fields:

masterData.accountHoldingPartyData.personalDetails.identityDocuments[0].id
masterData.accountHoldingPartyData.personalDetails.identityDocuments[1].id

  • Arrays with simple strings:

masterData.accountHoldingPartyData.contactDetails.emailAddresses[0]
masterData.accountHoldingPartyData.contactDetails.emailAddresses[1]

Timestamps

The required format for tenantProcessingTimestamp is: 2019-10-16T14:38:47:812

File transfer via SFTP

Batch files are transferred from your servers using SFTP:

  • Access to your SFTP server must be restricted by IP

  • Authentication must require username and password OR username and certificate. See Authentication for details on including your API key.

    Setup steps

    1. We provide our 4096-bit public key, used with our private key for authentication

    2. We provide our production IP range (see Environments for test environment details)

    3. Configure your SFTP server to authenticate via:

      1. Username + password + certificate, OR

      2. Restriction to provided IPs

    4. Ensure our service account has full permissions (read, rename, move files)

File naming and structure

  • Use stable prefixes for consistency (e.g., transactions_YYYYMMDD.zip, customers_YYYYMMDD.zip)

  • Supported formats:

    • ZIP archives (must contain a single file with the same name as the archive)

    • Encrypted ZIPs (AES256, ZipCrypto)

  • Multiple files must have clear, unique prefixes

Processing rules

  • Default processing speed is 10 TPS for sending customer/transaction checks (However, TPS limit is adjusted based on volume and SLA expectations)

  • Our batch service scans your server every few minutes for new files

    • For easy file recognition, provide a defined pattern (e.g., daily-batch.csv)

  • After processing, files are renamed with "_DONE"

    • Optionally, processed files can be moved to a designated folder

Required files

The following fields must be present in every batch file:

  • tenantTransactionId

  • tenantProcessingTimestamp

Files must be sorted by tenantProcessingTimestamp, with the oldest record at the top and the newest at the bottom.

Need custom batch formats?

If you need support for different batch file formats, please contact your Customer Success Manager.

Extended example

Here is a more comprehensive example of a batch CSV file:

batch-example-full
9.10 KB

The CSV is a combined example that illustrates headers used by Customer Checks and Transaction Checks. You can choose your batch type, modify as required, and upload via TEST SFTP.