Skip to main content
GET
Get a settlement operation

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

operationId
string
required

Settlement operation id (UUID).

Example:

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

Response

OK

cancellationTargetOperationId
string | null
required

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

Example:

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

createdAt
string
required

Creation timestamp (RFC3339).

Example:

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

currency
string
required

ISO 4217 currency code.

Example:

"BRL"

dueDate
string | null
required

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

Example:

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

eslcErrors
string[] | null
required

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

externalId
string
required

Client-side external identifier.

Example:

"acq-ext-2026-06-0001"

id
string
required

Operation id (UUID).

Example:

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

installmentNumber
integer<int32>
required

This installment's sequence number.

Example:

1

installments
integer<int32>
required

Total number of installments.

Example:

3

intakeMode
string
required

Intake mode the operation was received through.

Example:

"api_jsonl"

lastError
string | null
required

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

Example:

"ESLC0029"

nuliquid
string | null
required

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

Example:

"202606150000000000001"

operationType
string
required

Operation type.

Example:

"CREDIT"

participantId
string
required

Owning participant id (UUID).

Example:

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

participantRole
string
required

Participant role in the settlement.

Example:

"ACQUIRER"

reasonCategory
string | null
required

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

Example:

"4"

settlementIfIspb
string | null
required

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

Example:

"60746948"

state
string
required

Lifecycle state.

Example:

"SETTLED"

stuckSince
string | null
required

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

Example:

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

transactionDate
string
required

Business transaction date (RFC3339).

Example:

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

updatedAt
string
required

Last-update timestamp (RFC3339).

Example:

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

value
integer<int64>
required

Operation amount in minor units (centavos).

Example:

150000

waitingFor
enum<string> | null
required

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.

Available options:
transport,
nuclea_ack,
if_confirmation,
parked,
in_flight,
null
Example:

"nuclea_ack"

arrangementCode
string

Payment arrangement (arranjo) code.

Example:

"0245"

aslcType
string

ASLC message type materialized for this operation.

Example:

"ASLC027"

batchId
string

Batch id when created via the NDJSON batch endpoint.

Example:

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

creditorIspb
string

Creditor (acquirer) ISPB, 8 digits.

Example:

"29011780"

domicileIfIspb
string

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

Example:

"60701190"