Skip to main content
GET
Get a settlement operation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

operationId
string
obrigatório

Settlement operation id (UUID).

Exemplo:

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

Resposta

OK

cancellationTargetOperationId
string | null
obrigatório

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

Exemplo:

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

confirmationWindowClosedAt
string | null
obrigatório

Instant the IF Domicílio confirmation window closed without an answer for this operation (RFC3339); null unless overdueConfirmation is true.

Exemplo:

"2026-09-11T21:30:00Z"

createdAt
string
obrigatório

Creation timestamp (RFC3339).

Exemplo:

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

currency
string
obrigatório

ISO 4217 currency code.

Exemplo:

"BRL"

dueDate
string | null
obrigatório

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

Exemplo:

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

eslcErrors
string[]
obrigatório

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

externalId
string
obrigatório

Client-side external identifier.

Exemplo:

"acq-ext-2026-06-0001"

id
string
obrigatório

Operation id (UUID).

Exemplo:

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

installmentNumber
integer<int32>
obrigatório

This installment's sequence number.

Exemplo:

1

installments
integer<int32>
obrigatório

Total number of installments.

Exemplo:

3

intakeMode
string
obrigatório

Intake mode the operation was received through.

Exemplo:

"api_jsonl"

lastError
string | null
obrigatório

All recorded Núclea business error codes for the operation, joined into one comma-separated string; null when none. Read eslcErrors on this body for the codes as an array.

Exemplo:

"ESLC0029, ESLC0097"

nuliquid
string | null
obrigatório

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

Exemplo:

"202606150000000000001"

operationType
string
obrigatório

Operation type.

Exemplo:

"CREDIT"

overdueConfirmation
boolean
obrigatório

True when the IF Domicílio confirmation window for this operation type has closed and the operation is still FORWARDED with no ASLC023/ASLC033 back. A read fact, not a state: the operation stays FORWARDED and a late confirmation still settles.

Exemplo:

false

participantId
string
obrigatório

Owning participant id (UUID).

Exemplo:

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

participantRole
string
obrigatório

Participant role in the settlement.

Exemplo:

"ACQUIRER"

reasonCategory
string | null
obrigatório

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

Exemplo:

"4"

settlementIfIspb
string | null
obrigatório

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

Exemplo:

"60746948"

state
string
obrigatório

Lifecycle state.

Exemplo:

"SETTLED"

stuckSince
string | null
obrigatório

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

Exemplo:

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

transactionDate
string
obrigatório

Business transaction date (RFC3339).

Exemplo:

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

updatedAt
string
obrigatório

Last-update timestamp (RFC3339).

Exemplo:

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

value
integer<int64>
obrigatório

Operation amount in minor units (centavos).

Exemplo:

150000

waitingFor
enum<string> | null
obrigatório

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.

Opções disponíveis:
transport,
nuclea_ack,
if_confirmation,
parked,
in_flight,
null
Exemplo:

"nuclea_ack"

arrangementCode
string

Payment arrangement (arranjo) code.

Exemplo:

"0245"

aslcType
string

ASLC message type materialized for this operation.

Exemplo:

"ASLC027"

batchId
string

Batch id when created via the NDJSON batch endpoint.

Exemplo:

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

creditorIspb
string

Creditor (acquirer) ISPB, 8 characters.

Exemplo:

"29011780"

domicileIfIspb
string

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

Exemplo:

"60701190"