v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Ingestion

Upload transaction file

Use this endpoint to upload a transaction file (CSV, JSON, or XML) for ingestion into a reconciliation context. The file is parsed, validated, and transactions are extracted for matching.

post/v1/imports/contexts/{contextId}/sources/{sourceId}/upload

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

sourceIdstring required

The unique identifier of the reconciliation source.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Response

Indicates that the request was accepted for processing.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

completedAtstring

When the job completed in RFC3339 format (if completed)

contextIdstring

Context ID this job belongs to

createdAtstring

Creation timestamp in RFC3339 format

failedRowsinteger

Number of rows that failed processing

fileNamestring

Original file name

idstring

Unique identifier for the job

sourceIdstring

Source ID this job ingests data into

startedAtstring

When the job started in RFC3339 format (null for QUEUED jobs)

status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Current status of the job

totalRowsinteger

Total number of rows in the file

Example response

{
  "completedAt": "2025-01-15T10:35:00.000Z",
  "contextId": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "failedRows": 5,
  "fileName": "transactions_2024.csv",
  "id": "019c96a0-10ce-75fc-a273-dc799079a99c",
  "sourceId": "019c96a0-108c-7a74-8e31-3789daffe1ed",
  "startedAt": "2025-01-15T10:30:00.000Z",
  "status": "PROCESSING",
  "totalRows": 1000
}