Skip to main content
POST
Preview a 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
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, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

contextId
string<uuid>
required

The unique identifier of the reconciliation context. Context ID

sourceId
string<uuid>
required

The unique identifier of the reconciliation source. Source ID

Query Parameters

max_rows
integer<int64>

Maximum sample rows to return (default 5, max 20)

Required range: 1 <= x <= 20

Body

multipart/form-data
file
file
required

Sample file to preview (CSV, JSON, XML, or ISO 20022 camt.053)

format
enum<string>

File format (auto-detected from extension if omitted)

Available options:
csv,
json,
xml,
camt053
max_rows
integer

Maximum sample rows to return (default 5, max 20)

Response

File preview with detected columns and sample rows.

columns
string[] | null
required

Detected column names

Example:
format
string
required

Detected file format; camt053 is reported when a format=xml document auto-upgrades on an ISO 20022 camt namespace

Example:

"csv"

rowCount
integer<int64>
required

Number of sample rows returned

Example:

5

sampleRows
(string[] | null)[] | null
required

Sample data rows, one inner array per row (up to maxRows)