Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Adjust entry for an exception

Use this endpoint to resolve an exception by creating an adjustment entry. This is used when a monetary correction is needed to reconcile the transaction.

post/v1/exceptions/{exceptionId}/adjust-entry

Path parameters

exceptionIdstring required

Exception ID

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

amountnumber required

Adjustment amount

currencystring required

Currency code (ISO 4217)

effectiveAtstring date-time required

When the adjustment takes effect

notesstring required

Additional notes explaining the adjustment

reasonCodestring required

Reason code for the adjustment

Example request

{
  "amount": 150.5,
  "currency": "BRL",
  "notes": "Correcting processing fee discrepancy",
  "reasonCode": "FEE_ADJUSTMENT"
}

Response

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

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

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"
}