Pular para o conteúdo principal
POST
/
v1
/
exceptions
/
{exceptionId}
/
adjust-entry
Adjust entry for an exception
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/adjust-entry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 150.5,
  "currency": "BRL",
  "effectiveAt": "2023-11-07T05:31:56Z",
  "notes": "Correcting processing fee discrepancy",
  "reasonCode": "FEE_ADJUSTMENT"
}
'
{
  "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"
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

​
X-Request-Id
string

A unique identifier for tracing the request across services.

​
X-Idempotency-Key
string

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.

Parâmetros de caminho

​
exceptionId
string
obrigatório

Exception ID

Corpo

application/json

Adjust entry payload

Adjust entry request payload

​
amount
number
obrigatório

Adjustment amount

Exemplo:

150.5

​
currency
string
obrigatório

Currency code (ISO 4217)

Exemplo:

"BRL"

​
effectiveAt
string<date-time>
obrigatório

When the adjustment takes effect

​
notes
string
obrigatório

Additional notes explaining the adjustment

Maximum string length: 1000
Exemplo:

"Correcting processing fee discrepancy"

​
reasonCode
string
obrigatório

Reason code for the adjustment

Maximum string length: 255
Exemplo:

"FEE_ADJUSTMENT"

Resposta

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.

Exception details

​
assignedTo
string

User the exception is assigned to

Exemplo:

"user@example.com"

​
createdAt
string

Creation timestamp in RFC3339 format

Exemplo:

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

​
dueAt
string

Due date for resolution in RFC3339 format

Exemplo:

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

​
externalIssueId
string

External issue ID in the external system

Exemplo:

"RECON-1234"

​
externalSystem
string

External system where exception was dispatched

Exemplo:

"JIRA"

​
id
string

Unique identifier for the exception

Exemplo:

"019c96a0-10d2-7134-ba5f-664142ee7052"

​
reason
string

Reason the exception was raised

Exemplo:

"Amount mismatch detected"

​
resolutionNotes
string

Resolution notes when resolved

Exemplo:

"Resolved via force match"

​
resolutionReason
string

Reason for the resolution

Exemplo:

"BUSINESS_DECISION"

​
resolutionType
enum<string>

Type of resolution applied

Opções disponíveis:
FORCE_MATCH,
ADJUST_ENTRY
Exemplo:

"FORCE_MATCH"

​
severity
enum<string>

Severity level

Opções disponíveis:
LOW,
MEDIUM,
HIGH,
CRITICAL
Exemplo:

"HIGH"

​
status
enum<string>

Current status

Opções disponíveis:
OPEN,
ASSIGNED,
PENDING_RESOLUTION,
RESOLVED
Exemplo:

"OPEN"

​
transactionId
string

Transaction ID this exception is for

Exemplo:

"019c96a0-10ce-75fc-a273-dc799079a99c"

​
updatedAt
string

Last update timestamp in RFC3339 format

Exemplo:

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