Skip to main content
POST
Eliminar un contrato averbado del registro de nómina

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Mandatory opaque replay key, 1..128 bytes of valid UTF-8, preserved byte for byte. There is no X-Idempotency-Key alias, no case folding and no normalization: two keys differing in one byte are two keys.

Required string length: 1 - 128
Ejemplo:

"idem-exclusao-0001"

Parámetros de ruta

numero_contrato
string
requerido

The rail contract number (Manual 003 §3.3.1 p.15: Texto, 2 to 15 characters of free choice). Exact, control-free UTF-8: no trimming and no case folding.

Required string length: 2 - 15
Ejemplo:

"NC-000001"

Cuerpo

application/json
motivo_exclusao
enum<string>
requerido

The client's declared reason for removing the contract from the rail, as one of the closed codes Manual 003 §3.3.1 publishes: 1 desistência do empréstimo, 2 falecimento, 3 liquidação antecipada, 7 ação judicial, 8 exclusão por fraude, 9 outros. A string, never a JSON number. Mandatory on every request: the gateway never declares a reason on the client's behalf, and an absent or unpublished code is refused locally before the rail is called.

Opciones disponibles:
1,
2,
3,
7,
8,
9
Ejemplo:

"1"

Respuesta

A replay of an attempt that is already terminal: the outcome in the body is the earlier attempt's, and this call invoked nothing.

motivoExclusao
enum<string>
requerido

The client's declared Manual 003 §3.3.1 reason, echoed from the durable authority.

Opciones disponibles:
1,
2,
3,
7,
8,
9
Ejemplo:

"1"

numeroContrato
string
requerido

The contract number the exclusion was addressed to.

Ejemplo:

"NC-000001"

status
enum<string>
requerido

Durable operation status. confirmed means the contract came off the payroll; rejected means the registry published a refusal; claimed, invoking and outcome_unknown all mean the effect at the registry is NOT known yet and M005 reconciliation has to close it — none of the three is a failure to retry blindly.

Opciones disponibles:
claimed,
invoking,
confirmed,
rejected,
outcome_unknown
Ejemplo:

"confirmed"

evidenceSource
string

Which proof produced the terminal state: exclude_response, operator_evidence or m005_observation. Empty until one did.

Ejemplo:

"exclude_response"

message
string

The refusal message the REGISTRY published. Present only on a rejected operation.

Ejemplo:

"motivo nao publicado"

outcomeAt
string<date-time>

Instant the registry answered, RFC 3339 UTC. ABSENT until it did.

Ejemplo:

"2026-08-05T12:00:00Z"

providerReference
string

The registry's own receipt for the mutation. ABSENT when it minted none, which is the normal case under an m005_observation confirmation — absence is never a verdict.

Ejemplo:

"HASH-1"

reasonCode
string

The refusal code the REGISTRY published. Present only on a rejected operation.

Ejemplo:

"ME"