Skip to main content
GET
Get exception

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.

Path Parameters

​
exceptionId
string<uuid>
required

Exception ID Exception ID (UUID)

Example:

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

Response

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

​
createdAt
string
required

Creation timestamp as an RFC 3339 timestamp

Example:

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

​
id
string
required

Unique identifier for the exception (UUID)

Example:

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

​
severity
enum<string>
required

Severity level: LOW and MEDIUM are informational, HIGH needs prompt review, CRITICAL requires immediate action

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL
Example:

"HIGH"

​
status
enum<string>
required

Lifecycle status: OPEN (unhandled), ASSIGNED (owned by a user), PENDING_RESOLUTION (a resolution is in flight), RESOLVED (closed out)

Available options:
OPEN,
ASSIGNED,
PENDING_RESOLUTION,
RESOLVED
Example:

"OPEN"

​
transactionId
string
required

Identifier of the transaction this exception was raised for (UUID)

Example:

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

​
updatedAt
string
required

Last update timestamp as an RFC 3339 timestamp

Example:

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

​
amount
string

Enrichment: the exception transaction's amount as a decimal string in the transaction's currency. Present on list rows and get-by-id when the transaction still exists.

Example:

"1250.50"

​
assignedTo
string

User the exception is currently assigned to

Example:

"user@example.com"

​
contextId
string

Enrichment: id of the reconciliation context the exception's source belongs to (UUID). Present on list rows and get-by-id when the transaction and source still exist; powers the global triage queue's context attribution.

Example:

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

​
currency
string

Enrichment: ISO 4217 currency code of the exception transaction's amount. Present on list rows and get-by-id when the transaction still exists.

Example:

"USD"

​
dueAt
string

Resolution due date as an RFC 3339 timestamp

Example:

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

​
externalIssueId
string

Issue identifier in the external system, when dispatched

Example:

"RECON-1234"

​
externalSystem
string

External system the exception was dispatched to, when applicable

Example:

"JIRA"

​
reason
string

Reason the exception was originally raised

Example:

"Amount mismatch detected"

​
resolutionNotes
string

Free-text notes captured when the exception was resolved

Example:

"Resolved via force match"

​
resolutionReason
string

Reason code recorded for the resolution

Example:

"BUSINESS_DECISION"

​
resolutionType
string

How the exception was resolved.

Example:

"FORCE_MATCH"

​
resolvedAt
string

When the exception was resolved, as an RFC 3339 timestamp. Present only for RESOLVED exceptions.

Example:

"2025-01-15T12:00:00Z"

​
resolvedBy
string

Principal that resolved the exception (JWT sub, or 'system' for automated callback resolutions). Empty until resolved or when the resolving path is un-attributed.

Example:

"user@example.com"

​
runId
string

Identifier of the match run that LATEST surfaced this exception (UUID). Refreshed on every re-run that re-surfaces the break, so it names the most recent run that touched it; powers the run-precise jump from a run to its exceptions. Absent for legacy rows written before run linkage and for ingestion-minted duplicate-transaction breaks (not produced by a match run).

Example:

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

​
settlement
object

Settlement figures for a fee break (expected vs credited and the signed difference), derived from the live fee-variance snapshot recorded for the exception's transaction. Present on get-by-id only, and only when the snapshot and the transaction amount are both available in the same currency.

​
sourceId
string

Enrichment: id of the reconciliation source the exception transaction belongs to (UUID). Present on list rows and get-by-id when the transaction still exists.

Example:

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

​
sourceName
string

Enrichment: display name of the reconciliation source. Present on get-by-id when the transaction and its source still exist.

Example:

"Bank feed"

​
transactionDate
string

Enrichment: the exception transaction's value date as an RFC 3339 timestamp. Present on list rows and get-by-id when the transaction still exists.

Example:

"2025-01-14T00:00:00Z"