Skip to main content
GET
Read the FGTS guarantee execution this gateway holds for a contract

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

numero_contrato
string
obrigatório

The rail contract number whose guarantee execution is read.

Required string length: 1 - 15
Exemplo:

"99999999999AN1"

Resposta

OK

claimedAt
string<date-time>
obrigatório

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

Exemplo:

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

numeroContrato
string
obrigatório

The contract the guarantee execution was addressed to.

Exemplo:

"99999999999AN1"

status
enum<string>
obrigatório

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.

Opções disponíveis:
claimed,
executed,
unknown,
refused
Exemplo:

"executed"

dtPrevRepasse
string

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

Exemplo:

"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.

Exemplo:

"12345678901234567890123456789012"

settledAt
string<date-time>

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

Exemplo:

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