Reverse a refinancing within its 7 business day window

Proxies reverter-refinanciamento-trabalhador (Manual 008 v1.14 §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 and still be alive (not reversed, excluded or seen off the registry: GET …/standing), 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. When numeroContratoOriginal is supplied the refinancing must also have replaced that contract, else 422 REVERSAO_ORIGINAL_NOT_REPLACED before the rail is called. 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,
  "numeroContratoOriginal": "99999999999AR1",
  "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"
}

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.

Maximum string length: 255

Ejemplo:

"idem-reversao-0001"

Parámetros de ruta

numero_contrato · string · requerido

The NEW contract minted by the refinanciamento this call reverses.

Required string length: 2 - 15

Ejemplo:

"99999999999ARN1"

Cuerpo

application/json

motivoReversao · integer<int64> · requerido

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

Rango requerido: 1 <= x <= 3

Ejemplo:

1

numeroContratoOriginal · string

Optional. The original contract the operator is acting on, 2 to 15 letters or digits (the same rule as numero_contrato). When present, the reversal is refused with 422 REVERSAO_ORIGINAL_NOT_REPLACED unless it is one of the contracts the refinancing's listaContratosQuitadosTrabalhador named; the refusal leaves nothing recorded, and a replay under the same X-Idempotency returns the first answer. Absent: no check. Never sent to Dataprev.

Maximum string length: 15

Ejemplo:

"99999999999AR1"

parcelasContratosQuitados · string[] | null

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

Ejemplo:

["230.00"]

valorParcelaNovoContrato · string

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

Ejemplo:

"310.00"

Respuesta

200

application/json

OK

competenciaReversao · string · requerido

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

Ejemplo:

"202507"

hashOperacao · string · requerido

The rail's own identity for this operation.

Ejemplo:

"34006311"

listaContratosTrabalhadorReativados · object[] | null · requerido

Every quitado contract the reversal returned to ativo.

Show child attributes

Ejemplo:

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

mensagem · string · requerido

The rail's own message.

Ejemplo:

"Reversao realizada com sucesso"

numeroContratoExcluido · string · requerido

The new contract, now excluded by the reversal.

Ejemplo:

"99999999999ARN1"

margemReservada · string

The margin that was held reserved during the reversal window (Manual 008 v1.14 §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.

Ejemplo:

"310.00"