Reverse a refinancing within its 7 business day window

Proxies reverter-refinanciamento-trabalhador (Manual 008 v1.10 §3.2): the new contract is excluded and every contract it quitou returns to ativo. motivoReversao is a closed set (1 Desistência, 2 Óbito, 3 Fraude). ONLY a refinanciamento this gateway itself registered can be reversed here: the contract must be backed by an accepted refinanciamento of the authenticated tenant that no accepted reversal has already excluded, and anything else is 404 before the rail is called — a refinanciamento made outside this gateway (through the Dataprev Portal, say) has to be reversed there too. The 7-business-day window is judged against the gateway’s OWN record of when that refinanciamento committed, never against a date in the request, and it refuses locally only once the window has unambiguously passed; the rail remains the final judge. X-Idempotency is required.

POST /v1/consignado/contracts/{numero_contrato}/refinanciamento/reversao

Reverse a refinancing within its 7 business day window

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/refinanciamento/reversao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "motivoReversao": 1,
  "parcelasContratosQuitados": [
    "230.00"
  ],
  "valorParcelaNovoContrato": "310.00"
}
'

200

{
  "competenciaReversao": "202507",
  "hashOperacao": "34006311",
  "listaContratosTrabalhadorReativados": [
    {
      "numeroContrato": "99999999999AR1",
      "valorParcela": "230.00"
    }
  ],
  "mensagem": "Reversao realizada com sucesso",
  "numeroContratoExcluido": "99999999999ARN1",
  "margemReservada": "310.00"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string · required

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.

Example:

"idem-reversao-0001"

Path Parameters

numero_contrato · string · required

The NEW contract minted by the refinanciamento this call reverses.

Required string length: 2 - 15

Example:

"99999999999ARN1"

Body

application/json

motivoReversao · integer<int64> · required

Reversal reason (Manual 008 v1.10 §3.2.1, regra RG): 1 Desistência, 2 Óbito, 3 Fraude. Closed set — no 4th value exists.

Required range: 1 <= x <= 3

Example:

1

parcelasContratosQuitados · string[] | null

Instalment amounts of every contract this refinancing quitou, decimal strings (BRL). Optional; enables the margemReservada notice on the response.

Example:

["230.00"]

valorParcelaNovoContrato · string

The new (now-reversed) contract's own instalment amount, decimal string (BRL). Optional; enables the margemReservada notice on the response.

Example:

"310.00"

Response

200

application/json

OK

competenciaReversao · string · required

Payroll competência the reversal took effect in, yyyyMM.

Example:

"202507"

hashOperacao · string · required

The rail's own identity for this operation.

Example:

"34006311"

listaContratosTrabalhadorReativados · object[] | null · required

Every quitado contract the reversal returned to ativo.

Show child attributes

Example:

[
  {
    "numeroContrato": "99999999999AR1",
    "valorParcela": "230.00"
  }
]

mensagem · string · required

The rail's own message.

Example:

"Reversao realizada com sucesso"

numeroContratoExcluido · string · required

The new contract, now excluded by the reversal.

Example:

"99999999999ARN1"

margemReservada · string

The margin that was held reserved during the reversal window (Manual 008 v1.10 §3.2): the greater of the quitados' summed instalments and the new contract's own. Present only when the caller supplied enough context to compute it — a courtesy figure, not a rail field.

Example:

"310.00"