Get a settlement operation

Returns the full detail of one settlement operation, including its recorded eslcErrors and recoverability diagnostics.

GET /v1/operations/{operationId}

Get a settlement operation

cURL

curl --request GET \
  --url https://slc.sandbox.lerian.net/v1/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

200

{
  "cancellationTargetOperationId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "createdAt": "2026-06-15T10:50:00Z",
  "currency": "BRL",
  "dueDate": "2026-06-15T00:00:00Z",
  "eslcErrors": [
    "<string>"
  ],
  "externalId": "acq-ext-2026-06-0001",
  "id": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "installmentNumber": 1,
  "installments": 3,
  "intakeMode": "api_jsonl",
  "lastError": "ESLC0029",
  "nuliquid": "202606150000000000001",
  "operationType": "CREDIT",
  "participantId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "participantRole": "ACQUIRER",
  "reasonCategory": "4",
  "settlementIfIspb": "60746948",
  "state": "SETTLED",
  "stuckSince": "2026-06-15T11:00:00Z",
  "transactionDate": "2026-06-15T00:00:00Z",
  "updatedAt": "2026-06-15T13:10:00Z",
  "value": 150000,
  "waitingFor": "nuclea_ack",
  "arrangementCode": "0245",
  "aslcType": "ASLC027",
  "batchId": "018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e",
  "creditorIspb": "29011780",
  "domicileIfIspb": "60701190"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

operationId · string · requerido

Settlement operation id (UUID).

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Respuesta

200

application/json

OK

cancellationTargetOperationId · string | null · requerido

Id (UUID) of the operation a CANCELLATION targets; null for every other type.

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

createdAt · string · requerido

Creation timestamp (RFC3339).

Ejemplo:

"2026-06-15T10:50:00Z"

currency · string · requerido

ISO 4217 currency code.

Ejemplo:

"BRL"

dueDate · string | null · requerido

Settlement due date (RFC3339); null when not set.

Ejemplo:

"2026-06-15T00:00:00Z"

eslcErrors · string[] | null · requerido

Recorded Núclea business error codes (empty array when none).

externalId · string · requerido

Client-side external identifier.

Ejemplo:

"acq-ext-2026-06-0001"

id · string · requerido

Operation id (UUID).

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

installmentNumber · integer<int32> · requerido

This installment's sequence number.

Ejemplo:

1

installments · integer<int32> · requerido

Total number of installments.

Ejemplo:

3

intakeMode · string · requerido

Intake mode the operation was received through.

Ejemplo:

"api_jsonl"

lastError · string | null · requerido

Most recent recorded Núclea business error code; null when none.

Ejemplo:

"ESLC0029"

nuliquid · string | null · requerido

Núclea-assigned NUliquid (21 positions); null until assigned.

Ejemplo:

"202606150000000000001"

operationType · string · requerido

Operation type.

Ejemplo:

"CREDIT"

participantId · string · requerido

Owning participant id (UUID).

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

participantRole · string · requerido

Participant role in the settlement.

Ejemplo:

"ACQUIRER"

reasonCategory · string | null · requerido

Numeric MotvCanc cancellation reason ('1'..'4'); null unless a CANCELLATION.

Ejemplo:

"4"

settlementIfIspb · string | null · requerido

Settlement FI ISPB, 8 digits; null when not set.

Ejemplo:

"60746948"

state · string · requerido

Lifecycle state.

Ejemplo:

"SETTLED"

stuckSince · string | null · requerido

Timestamp since the operation has been internally stuck (RFC3339); null when not stuck.

Ejemplo:

"2026-06-15T11:00:00Z"

transactionDate · string · requerido

Business transaction date (RFC3339).

Ejemplo:

"2026-06-15T00:00:00Z"

updatedAt · string · requerido

Last-update timestamp (RFC3339).

Ejemplo:

"2026-06-15T13:10:00Z"

value · integer<int64> · requerido

Operation amount in minor units (centavos).

Ejemplo:

150000

waitingFor · enum<string> | null · requerido

What the operation is waiting on, and therefore which recovery verb applies. transport/nuclea_ack/if_confirmation are external waits (reconcile or wait). parked means an outbound transmit claim is held because the attempt budget was exhausted and nothing reached Núclea: recover with POST /v1/connectivity/unpark. in_flight means the file IS at Núclea and the local transition failed: reconcile with Núclea, then POST /v1/operations/{operationId}/advance, and NEVER un-park it. null names NO verb: it means no external dependency is named for this state — the operation is terminal, or the wait is internal (CREATED/ACCEPTED, where advance/requeue applies), or it awaits a counterpart this vocabulary does not name yet (CONFIRMED awaits the funding ack plus the Núclea cycle close; SETTLED awaits the D+1 return file). Pair a null with state before choosing an action.

Opciones disponibles: transport, nuclea_ack, if_confirmation, parked, in_flight, null

Ejemplo:

"nuclea_ack"

arrangementCode · string

Payment arrangement (arranjo) code.

Ejemplo:

"0245"

aslcType · string

ASLC message type materialized for this operation.

Ejemplo:

"ASLC027"

batchId · string

Batch id when created via the NDJSON batch endpoint.

Ejemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

creditorIspb · string

Creditor (acquirer) ISPB, 8 digits.

Ejemplo:

"29011780"

domicileIfIspb · string

Domicile FI ISPB (bank where the merchant receives funds), 8 digits.

Ejemplo:

"60701190"