Suspend payroll deduction for an averbado contract

Proxies suspender-consignado-trabalhador (Manual 003 §3.4). The contract must be an averbação of the authenticated tenant that the rail acknowledged; anything else is 404 before the rail is called. X-Idempotency is required. Competência is calculated by the rail and is never sent. Reversible by the reactivate operation.

POST /v1/consignado/contracts/{numero_contrato}/suspend

Suspend payroll deduction for an averbado contract

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/suspend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "cpf": "99999999999",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "42422253000101"
}
'

200

{
  "hashOperacao": "33908101"
}

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.

Ejemplo:

"idem-lifecycle-2026-07-30-0001"

Parámetros de ruta

numero_contrato · string · requerido

Rail contract number of an averbação belonging to the authenticated tenant.

Required string length: 1 - 15

Ejemplo:

"99999999999AN1"

Cuerpo

application/json

codigoInscricaoEmpregador · enum<string> · requerido

Employer inscription type: 1 = CNPJ, 2 = CPF.

Opciones disponibles: 1, 2

Ejemplo:

"1"

cpf · string · requerido

Worker CPF, exactly 11 digits. In the BODY, never a path or query parameter.

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

Ejemplo:

"99999999999"

matricula · string · requerido

Minimum string length: 1

Ejemplo:

"99999999999-A"

numeroInscricaoEmpregador · string · requerido

Minimum string length: 1

Ejemplo:

"42422253000101"

Respuesta

200

application/json

OK

hashOperacao · string

The rail's own operation identity, surfaced as its exact decimal digits (the rail types it Numérico). Manual 003 publishes no response table for these operations, so it MAY be absent on a 2xx — a 2xx is itself the success signal, do not branch on this field being present.

Ejemplo:

"33908101"