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

Upload transaction file

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/imports/contexts/{contextId}/sources/{sourceId}/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@example-file \
  --form 'format=<string>'

202

Example

{
  "completedWithErrors": true,
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "droppedDuplicateRows": 60,
  "failureRatePercent": 100,
  "flaggedDuplicateRows": 15,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "persistedRows": 940,
  "reviewRows": 9,
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PROCESSING",
  "completedAt": "2025-01-15T10:35:00Z",
  "diagnosis": "file appears semicolon-delimited but the source declares comma; declare delimiter semicolon in the source dialect",
  "droppedDuplicateReason": "Rows repeated the duplicate key this source deduplicates on and were kept out of the import. This source flags duplicates, so each repeat whose original was found was attached to that original as a duplicate exception in the exceptions queue. Repeats of the same original share one exception, so the queue holds one item per repeated row, not one per repeat. The rest found no imported row to attach to (another import of this source may still have been in progress), so no exception was raised for them and they are not in the queue: re-upload those rows once every import of this source has finished. If unexpected, review the source's duplicate key and the fields it names (a coarse or truncated mapping collapses distinct rows onto one key).",
  "failedRows": 5,
  "fileName": "transactions_2024.csv",
  "startedAt": "2025-01-15T10:30:00Z",
  "totalRows": 1000
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

sourceId · string<uuid> · requerido

The unique identifier of the reconciliation source. Source ID

Cuerpo

multipart/form-data

file · file · requerido

Transaction file (CSV, JSON, XML, or camt.053)

format · string

Canonical file-format key. Legacy flat keys (csv, json, xml, camt053) and namespaced keys (e.g. xx/delimited/generic, br/acquirer_csv/mercadopago) are accepted; discover the full set via GET /v1/imports/formats. Send before the file part. When omitted, inferred from the .csv/.json file extension.

Respuesta

202

application/json

Indicates that the request was accepted for processing.

completedWithErrors · boolean · requerido

True when the job COMPLETED but at least one row failed — distinguishes a partially-failed import from a clean one

Ejemplo:

true

contextId · string<uuid> · requerido

Reconciliation context this job belongs to

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string<date-time> · requerido

Creation timestamp (RFC 3339)

Ejemplo:

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

droppedDuplicateRows · integer<int64> · requerido

Number of rows kept out of the import as duplicates (rows repeating the source's duplicate key within the upload or already persisted); see flaggedDuplicateRows for how many were also raised as exceptions

Rango requerido: x >= 0

Ejemplo:

60

failureRatePercent · integer<int64> · requerido

Percentage of rows that failed, ceiling-rounded so any failure registers as at least 1%; 0 when no rows failed

Rango requerido: 0 <= x <= 100

Ejemplo:

100

flaggedDuplicateRows · integer<int64> · requerido

Number of dropped duplicate ROWS raised as DUPLICATE_TRANSACTION exceptions on the transaction they repeated, under the FLAG_AS_EXCEPTION duplicate policy — the default (subset of droppedDuplicateRows). Not a queue-item count: repeats of the same transaction share one exception, which carries how many times it was repeated

Rango requerido: x >= 0

Ejemplo:

15

id · string<uuid> · requerido

Unique identifier for the job

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

persistedRows · integer<int64> · requerido

Number of transactions actually persisted by this job (additive diagnostics field; see also droppedDuplicateRows)

Rango requerido: x >= 0

Ejemplo:

940

reviewRows · integer<int64> · requerido

Number of rows imported with status PENDING_REVIEW under the blank_external_id=NEEDS_REVIEW source policy — successful imports awaiting operator review, never counted as failures

Rango requerido: x >= 0

Ejemplo:

9

sourceId · string<uuid> · requerido

Source this job ingests data into

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

status · enum<string> · requerido

Job lifecycle status: QUEUED (awaiting a worker), PROCESSING (parsing/normalizing rows), COMPLETED (finished), FAILED (aborted wholesale)

Opciones disponibles: QUEUED, PROCESSING, COMPLETED, FAILED

Ejemplo:

"PROCESSING"

completedAt · string<date-time>

When the job completed (RFC 3339); null until completed

Ejemplo:

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

diagnosis · string

Safe one-line diagnosis of anything the parser found worth reporting about the file (dialect mismatch, degraded settlement re-join, zero-detail file), the rate-policy message for policy-FAILED jobs, or a generic safe message for other FAILED jobs. Present on COMPLETED jobs too, including ones with zero failed rows; empty when there is nothing to report — internal error detail is never surfaced here

Ejemplo:

"file appears semicolon-delimited but the source declares comma; declare delimiter semicolon in the source dialect"

droppedDuplicateReason · string

Display-only explanation of why droppedDuplicateRows rows were kept out of the import: names the source's duplicate key as the identity that collided, says the repeats were attached as exceptions to the rows they repeated when the job flagged any (repeats of one row share one exception, so the queue holds one item per repeated row), and names the repeats that raised nothing when fewer were flagged than dropped, so the count does not read as silent data loss and the customer is sent to the configuration that decides it. Empty unless droppedDuplicateRows > 0

Ejemplo:

"Rows repeated the duplicate key this source deduplicates on and were kept out of the import. This source flags duplicates, so each repeat whose original was found was attached to that original as a duplicate exception in the exceptions queue. Repeats of the same original share one exception, so the queue holds one item per repeated row, not one per repeat. The rest found no imported row to attach to (another import of this source may still have been in progress), so no exception was raised for them and they are not in the queue: re-upload those rows once every import of this source has finished. If unexpected, review the source's duplicate key and the fields it names (a coarse or truncated mapping collapses distinct rows onto one key)."

failedRows · integer<int64>

Number of rows that failed parsing or normalization

Rango requerido: x >= 0

Ejemplo:

5

fileName · string

Original uploaded file name

Ejemplo:

"transactions_2024.csv"

startedAt · string<date-time>

When the job started (RFC 3339); null for QUEUED jobs

Ejemplo:

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

totalRows · integer<int64>

Total number of data rows detected in the file

Rango requerido: x >= 0

Ejemplo:

1000