Exclude a contract from this institution because the worker ported it out

Proxies excluir-portabilidade-trabalhador (Manual 008 v1.14 §4.1), the ORIGIN institution’s write: the contract named in the path stops being consigned here because the worker moved it to the institution named by codigoProponente. codigoOrigem is never accepted from the caller — it is the authenticated tenant’s own COMPE/CBC. The contract must be held by this gateway for the authenticated tenant; anything else is 404 before the rail is called. The call is claimed durably before it departs and closed durably after the answer lands, so a retry under the same X-Idempotency key is answered from the retained rail answer instead of excluding a second time, and a call whose outcome nobody established is reconciled against the registry rather than lost; a call the reconciliation cannot decide is the bank’s to close through POST /v1/consignado/rail-commands//close (accepted publishes consignado.portabilidade.efetivada, refused publishes consignado.portabilidade.rejeitada with reason_code GW-BANCO-RECUSADO). Success publishes consignado.portabilidade.efetivada; a published refusal, a call that executed nothing (an OZ-only turnover, a proven-unexecuted refusal, or a call that never left the gateway, reason_code GW-NAO-ENVIADO), or an unknown outcome that still reads Ativo in an M005 read started one hour past its deadline (reason_code GW-M005-NAO-EXECUTADO), publishes consignado.portabilidade.rejeitada. A portability the client performs OUTSIDE this gateway publishes nothing: Manual 008 §5.4’s consulta is proponente-only, so the origin institution has no discovery path. X-Idempotency is required.

POST /v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao

Exclude a contract from this institution because the worker ported it out

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "codigoProponente": "994",
  "cpfTrabalhador": "99999999999",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "99999999999881",
  "numeroUnico": "123456789012345678901",
  "ultimaParcelaPaga": 5
}
'

200

{
  "codigoSucesso": "00",
  "competenciaExclusao": 202609,
  "hashOperacao": "34006311",
  "mensagem": "Exclusao realizada com sucesso",
  "numeroContrato": "99999999999AP1",
  "submittedAt": "2026-08-29T12:00:00Z",
  "ultimaParcelaPaga": 5
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. It is the durable replay identity of this command.

Required string length: 1 - 128

Ejemplo:

"idem-exclusao-portabilidade-0001"

Parámetros de ruta

numero_contrato · string · requerido

The contract leaving this institution. Must be held by this gateway for the authenticated tenant.

Required string length: 2 - 15

Ejemplo:

"99999999999AP1"

Cuerpo

application/json

codigoInscricaoEmpregador · string · requerido

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$

Ejemplo:

"1"

codigoProponente · string · requerido

COMPE/CBC of the DESTINATION institution taking the contract. Caller input, because this gateway cannot know it.

Required string length: 1 - 3

Pattern: ^[0-9]{1,3}$

Ejemplo:

"994"

cpfTrabalhador · string · requerido

Worker CPF, 11 digits.

Required string length: 11

Pattern: ^[0-9]{11}$

Ejemplo:

"99999999999"

matricula · string · requerido

Matrícula assigned to the worker by the employer.

Required string length: 1 - 30

Ejemplo:

"99999999999-A"

numeroInscricaoEmpregador · string · requerido

Employer inscription number, Texto per the manual (the mirrored Swagger still types this int64).

Required string length: 1 - 14

Ejemplo:

"99999999999881"

numeroUnico · string · requerido

Número único identificador da portabilidade (NSU oriundo da CIP). A digit STRING: Manual 008 publishes exactly 21 algarismos, which overflows every conventional numeric type, so it stays text end to end.

Required string length: 21

Pattern: ^[0-9]{21}$

Ejemplo:

"123456789012345678901"

ultimaParcelaPaga · integer<int64>

Last instalment already paid on the contract being excluded. Optional; omit it rather than sending 0 when unknown.

Rango requerido: 0 <= x <= 999

Ejemplo:

5

Respuesta

200

application/json

OK

codigoSucesso · string · requerido

The rail's own success code.

Ejemplo:

"00"

competenciaExclusao · integer<int64> · requerido

Payroll competência in which the exclusion takes effect, yyyyMM.

Ejemplo:

202609

hashOperacao · string · requerido

The rail's own identity for this operation. Texto on this operation, unlike the other exclusion operations where the same field name is Número.

Ejemplo:

"34006311"

mensagem · string · requerido

The rail's own message.

Ejemplo:

"Exclusao realizada com sucesso"

numeroContrato · string · requerido

The contract this exclusion removed from the origin institution.

Ejemplo:

"99999999999AP1"

submittedAt · string<date-time> · requerido

When this gateway durably authorized the rail call, RFC 3339 UTC.

Ejemplo:

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

ultimaParcelaPaga · integer<int64>

Last instalment the rail reports as paid on the excluded contract. Omitted when the acknowledgement carries no entry for the commanded contract: 0 is a live value (exclusion before any instalment was paid), so absence must not fabricate it.

Ejemplo:

5