Skip to main content
POST
Cancel an export job

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

​
jobId
string<uuid>
required

Export Job ID

Response

Indicates that the request was successful and the response contains the expected data.

​
bytesWritten
integer<int64>
required

Size of the export file in bytes.

Example:

524288

​
contextId
string<uuid>
required

Identifier of the reconciliation context this export was queued for (UUID).

Example:

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

​
createdAt
string<date-time>
required

Timestamp when the job was created (RFC 3339, UTC).

Example:

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

​
expiresAt
string<date-time>
required

Timestamp after which the export file is purged and no longer downloadable (RFC 3339, UTC).

Example:

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

​
format
enum<string>
required

File format of the exported report.

Available options:
CSV,
JSON,
XML,
PDF
Example:

"CSV"

​
id
string<uuid>
required

Identifier of the export job (UUID).

Example:

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

​
recordsWritten
integer<int64>
required

Number of records written to the export file.

Example:

4250

​
reportType
enum<string>
required

Type of report this job exports.

Available options:
MATCHED,
UNMATCHED,
SUMMARY,
VARIANCE,
EXCEPTIONS,
MATCHES,
UNMATCHED_TRANSACTIONS
Example:

"MATCHED"

​
status
enum<string>
required

Current lifecycle status: QUEUED (waiting), RUNNING (in progress), SUCCEEDED (complete and downloadable), FAILED (errored), EXPIRED (file no longer available), CANCELED (cancelled by user).

Available options:
QUEUED,
RUNNING,
SUCCEEDED,
FAILED,
EXPIRED,
CANCELED
Example:

"SUCCEEDED"

​
downloadUrl
string

Presigned download URL, present only when the job has succeeded and the file is still available.

Example:

"https://storage.example.com/exports/matched_report.csv?token=abc"

​
error
string

Failure reason, present only when the job status is FAILED.

Example:

"timeout exceeded"

​
fileName
string

Generated export file name, present once the job has produced a file.

Example:

"matched_report_2025-01-31.csv"

​
finishedAt
string<date-time>

Timestamp when processing finished, present once the job reaches a terminal state (RFC 3339, UTC).

Example:

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

​
startedAt
string<date-time>

Timestamp when processing started, present once the job has begun running (RFC 3339, UTC).

Example:

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