Skip to main content
POST
Upload transaction file

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

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.

Path Parameters

contextId
string
required

The unique identifier of the reconciliation context.

sourceId
string
required

The unique identifier of the reconciliation source.

Body

multipart/form-data
file
file
required

Transaction file (CSV, JSON, or XML)

format
enum<string>
required

File format

Available options:
csv,
json,
xml

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.

Ingestion job details

completedAt
string

When the job completed in RFC3339 format (if completed)

Example:

"2025-01-15T10:35:00.000Z"

contextId
string

Context ID this job belongs to

Example:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

createdAt
string

Creation timestamp in RFC3339 format

Example:

"2025-01-15T10:30:00.000Z"

failedRows
integer

Number of rows that failed processing

Required range: x >= 0
Example:

5

fileName
string

Original file name

Example:

"transactions_2024.csv"

id
string

Unique identifier for the job

Example:

"019c96a0-10ce-75fc-a273-dc799079a99c"

sourceId
string

Source ID this job ingests data into

Example:

"019c96a0-108c-7a74-8e31-3789daffe1ed"

startedAt
string

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

Example:

"2025-01-15T10:30:00.000Z"

status
enum<string>

Current status of the job

Available options:
QUEUED,
PROCESSING,
COMPLETED,
FAILED
Example:

"PROCESSING"

totalRows
integer

Total number of rows in the file

Required range: x >= 0
Example:

1000