Skip to main content
GET
Read the exclusion this gateway holds for a contract

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

numero_contrato
string
required

The rail contract number whose exclusion is read.

Required string length: 2 - 15
Example:

"NC-000001"

Response

The exclusion operation that describes the contract now.

motivoExclusao
enum<string>
required

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

Available options:
1,
2,
3,
7,
8,
9
Example:

"1"

numeroContrato
string
required

The contract number the exclusion was addressed to.

Example:

"NC-000001"

status
enum<string>
required

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.

Available options:
claimed,
invoking,
confirmed,
rejected,
outcome_unknown
Example:

"confirmed"

evidenceSource
string

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

Example:

"exclude_response"

message
string

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

Example:

"motivo nao publicado"

outcomeAt
string<date-time>

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

Example:

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

Example:

"HASH-1"

reasonCode
string

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

Example:

"ME"