Read the FGTS guarantee execution this gateway holds for a contract

Reads the FGTS-guarantee execution this gateway durably holds for one contract (Manual 017 v1.5 §2.1).

It is a LOCAL read: it never calls Dataprev, opens no worker consent and spends none of the rail’s rate budget. There is nothing out there to call — Manual 017 publishes consultar-saldo, listar-autorizados and the execution itself, and NO operation that asks the registry whether it already executed. The gateway’s own row is the whole answer, which is why an unestablished outcome is reconciled by an operator rather than retried.

This exists because the execution is the one irreversible cash movement whose outcome used to be readable in exactly one place: the response to the POST that performed it. A closed tab or a dropped connection left an operator unable to tell whether the money moved.

The four statuses, and what each one means for the caller:

Status	Meaning
executed	The rail confirmed. protocolo is the receipt and dtPrevRepasse the forecast repasse date
refused	The rail PROVED it executed nothing. Terminal for that idempotency key, but the contract is released: a corrected request under a NEW key may execute
claimed	The gateway recorded the request and the rail has not answered yet
unknown	The outcome could not be established. Terminal for the key, and the contract stays fenced until an operator reconciles — retrying could execute the guarantee twice

404 means the gateway holds no execution record for this contract. It is never answered as an empty record: on a movement with no undo, “we hold nothing” and “we hold a claim nobody settled” are the two answers that must never be confused.

The idempotency key and the payload digest are not published. They are internal replay mechanics, and the digest fingerprints a body carrying the worker’s CPF.

GET /v1/consignado/contracts/{numero_contrato}/fgts-garantia/execucao

Read the FGTS guarantee execution this gateway holds for a contract

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/fgts-garantia/execucao \
  --header 'Authorization: Bearer <token>'

200

{
  "claimedAt": "2026-07-30T12:00:00Z",
  "numeroContrato": "99999999999AN1",
  "status": "executed",
  "dtPrevRepasse": "2026-07-15",
  "protocolo": "12345678901234567890123456789012",
  "settledAt": "2026-07-30T12:00:04Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

numero_contrato · string · requerido

The rail contract number whose guarantee execution is read.

Required string length: 1 - 15

Ejemplo:

"99999999999AN1"

Respuesta

200

application/json

OK

claimedAt · string<date-time> · requerido

Instant the gateway durably recorded the request, RFC 3339 UTC. It is written BEFORE the rail call, so it exists for every record here.

Ejemplo:

"2026-07-30T12:00:00Z"

numeroContrato · string · requerido

The contract the guarantee execution was addressed to.

Ejemplo:

"99999999999AN1"

status · enum<string> · requerido

Durable status. executed means the rail confirmed and the protocolo is the proof; refused means the rail PROVED it executed nothing, which releases the contract for a corrected request under a fresh key; claimed and unknown both mean the effect at the rail is NOT established, and Manual 017 publishes no operation that asks it — so neither is a retry, both are operator reconciliation.

Opciones disponibles: claimed, executed, unknown, refused

Ejemplo:

"executed"

dtPrevRepasse · string

Forecast repasse date (yyyy-MM-dd), as the rail published it. Absent when it published none.

Ejemplo:

"2026-07-15"

protocolo · string

The rail's own receipt for the movement, up to 32 digits. A string so 32 digits survive without precision loss. Present only on an executed record.

Ejemplo:

"12345678901234567890123456789012"

settledAt · string<date-time>

Instant the record reached its terminal state, RFC 3339 UTC. ABSENT while the record is still claimed.

Ejemplo:

"2026-07-30T12:00:04Z"