Data Source Configuration
Configure Stripe, CSV, EBICS, and SFTP data sources.
What is data source config
Data source configuration defines how incoming transactions are ingested. For Stripe, EBICS, SFTP, and CSV, you create a connection scoped to tenant and environment. CSV connections anchor file uploads and sync logs even when config is empty.
See Data Sources for the conceptual overview.
Stripe
Create a Stripe connection via POST /data-sources:
| Name | Type | Required | Description |
|---|---|---|---|
| source | string | Yes | stripe |
| name | string | Yes | Display name |
| config.apiKey | string | Yes | Stripe secret key (sk_live_... or sk_test_...) |
| config.webhookSecret | string | No | Webhook signing secret for verification |
| enabled | boolean | No | Default: true |
Sync runs manually (POST /data-sources/stripe/sync) or on a schedule via Job Scheduling.
CSV
Create a connection with source: "csv" and config: {} (or optional metadata). Upload via POST /incoming-transactions/upload with dataSourceConnectionId and a multipart file. Configure field mappings for source csv to map columns. Supports comma, semicolon, or tab delimiters.
SFTP
Create an SFTP connection via POST /data-sources with source: sftp and a JSON config:
| Name | Type | Required | Description |
|---|---|---|---|
| source | string | Yes | sftp |
| name | string | Yes | Display name |
| config.host | string | Yes | SFTP server hostname |
| config.port | number | No | SSH port (default 22) |
| config.username | string | Yes | SSH username |
| config.auth | object | Yes | Either { "password": "..." } or { "privateKey": "PEM...", "passphrase": "..." } (passphrase optional) |
| config.remotePath | string | Yes | Remote directory to scan (files only; subfolders are not walked in v1) |
| config.filePattern | string | No | Glob-style pattern (default *.csv). Only .csv files are ingested in v1 |
| config.delimiter | string | No | Single CSV delimiter character (default ,) |
| config.encoding | string | No | Buffer encoding for file contents (default utf8) |
| config.hostKeyFingerprint | string | No | SHA-256 host key: 64-char hex or OpenSSH SHA256:... form (recommended for production) |
| config.knownHosts | string | No | Reserved for future strict host checking |
| config.moveToPath | string | No | After a successful file import, rename the remote file into this directory |
| config.deleteAfterSuccess | boolean | No | After success, delete the remote file (ignored if moveToPath is set) |
The API validates config on create and update (invalid configs return 400). The service stores _sftpState in config for idempotent skips (do not remove unless you intend to reprocess files).
Sync: POST /data-sources/sftp/sync with {"connectionId": "<uuid>"}. Configure field mappings for source sftp when you need custom column mapping; otherwise the same defaults as CSV apply.
EBICS
Use POST /data-sources/ebics/init/start (not POST /data-sources). After the bank activates keys, call POST /data-sources/ebics/init/complete.
Init start body:
| Name | Type | Required | Description |
|---|---|---|---|
| bankUrl | string | Yes | EBICS server URL (PostFinance test: https://isotest.postfinance.ch/ebicsweb/ebicsweb) |
| hostId | string | Yes | Bank host ID (PostFinance: PFEBICS) |
| partnerId | string | Yes | Customer / partner ID |
| userId | string | Yes | Participant / user ID |
| passphrase | string | Yes | Passphrase for key storage (encrypted at rest) |
| accountId | string | Yes | Account IBAN |
| bankId | string | Yes | Parser id (e.g. postfinance) |
| ebicsVersion | string | Yes | H004 (EBICS 2.5) or H005 (EBICS 3.0) |
| statementDownloadOrderType | string | No | H004 only: C53, Z53, or G53. Omit for bank defaults (PostFinance → Z53) |
| name | string | No | Display name |
Stored on the connection config after init: bankUrl, hostId, partnerId, userId, accountId, bankId, ebicsVersion, optional statementDownloadOrderType, encrypted key material, sync metadata. Passphrase is not stored in cleartext.
Init complete body:
| Name | Type | Required | Description |
|---|---|---|---|
| connectionId | string | Yes | ID from init/start |
Sync: POST /data-sources/ebics/sync with {"connectionId": "..."}. H004 uses C53/Z53/G53; H005 uses BTD (ZIP-wrapped CAMT when applicable). Requires EBICS_KEY_ENCRYPTION_KEY (32+ chars).
Related
- Data Sources — Conceptual overview
- Data Sources API — Create, list, sync
- Field Mappings — Transform raw data