v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Exception

Get exception

Use this endpoint to retrieve the details of a specific exception by its identifier.

get/v1/exceptions/{exceptionId}

Path parameters

exceptionIdstring required

Exception ID

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

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

assignedTostring

User the exception is assigned to

createdAtstring

Creation timestamp in RFC3339 format

dueAtstring

Due date for resolution in RFC3339 format

externalIssueIdstring

External issue ID in the external system

externalSystemstring

External system where exception was dispatched

idstring

Unique identifier for the exception

reasonstring

Reason the exception was raised

resolutionNotesstring

Resolution notes when resolved

resolutionReasonstring

Reason for the resolution

resolutionType'FORCE_MATCH' | 'ADJUST_ENTRY'

Type of resolution applied

severity'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Severity level

status'OPEN' | 'ASSIGNED' | 'PENDING_RESOLUTION' | 'RESOLVED'

Current status

transactionIdstring

Transaction ID this exception is for

updatedAtstring

Last update timestamp in RFC3339 format

Example response

{
  "assignedTo": "user@example.com",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "dueAt": "2025-01-20T10:30:00.000Z",
  "externalIssueId": "RECON-1234",
  "externalSystem": "JIRA",
  "id": "019c96a0-10d2-7134-ba5f-664142ee7052",
  "reason": "Amount mismatch detected",
  "resolutionNotes": "Resolved via force match",
  "resolutionReason": "BUSINESS_DECISION",
  "resolutionType": "FORCE_MATCH",
  "severity": "HIGH",
  "status": "OPEN",
  "transactionId": "019c96a0-10ce-75fc-a273-dc799079a99c",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}