Close a parked refinanciamento, renegociação, alteração, legado renegociação or portability exclusion by what the Dataprev portal shows

The bank closes a refinanciamento, renegociação, alteração de termos, legado renegociação or portability exclusion the gateway parked in outcome_unknown, stating what the Dataprev portal shows. The close settles the contract as an accepted or refused answer would: the saldo devedor (M015) obligations move in the same commit, and a refinanciamento or renegociação also publishes the outcome fact recovery would: consignado.refinanciamento.efetivado or .recusado, consignado.renegociacao.efetivada or .recusada. An alteração or legado renegociação publishes no fact, as its live answer publishes none; a portability exclusion publishes consignado.portabilidade.efetivada or .rejeitada. refused reads nothing at Dataprev: the row closes rejected under response_code GW-BANCO-RECUSADO. On a refinanciamento or renegociação the new contract number is free for a new command and the refusal fact carries reason_code GW-BANCO-RECUSADO (a renegociação's with refused_by dataprev); an alteração or legado renegociação publishes no fact; a portability exclusion publishes consignado.portabilidade.rejeitada with reason_code GW-BANCO-RECUSADO and a gateway sentence that never carries the operator's subject or evidence. accepted on an alteração de termos reads nothing: the row closes accepted under GW-BANCO-ALTERADO and the obligation moves to the terms the call claimed (installments, value and first competência); the bank's statement is not checked against Dataprev. It answers 409 RAIL_COMMAND_NOT_CLOSEABLE for an alteração parked with no claimed terms, or one a later alteração of the same contract supersedes. accepted on a refinanciamento, renegociação or legado renegociação reads the new contract once through consultar-emprestimo-trabalhador (Manual 005 v1.16 §3.2.1), because its terms come from that read: the row closes accepted under GW-BANCO-REFINANCIADO, GW-BANCO-RENEGOCIADO or GW-BANCO-LEGADO-RENEGOCIADO, the replaced contracts' obligations end (a refinanciamento's each owe a final 0.00), and the new contract's obligation opens. The bank's statement overrides who minted the contract and when (origemAverbacao, dataHoraInclusaoEmprestimo), except a legado renegociação's read must show origemAverbacao 6 (Manual 005, "Renegociação de Empréstimo Legado"); another origem answers 409 RAIL_COMMAND_CLOSE_CONTRADICTED. A read showing the contract absent (HY), another contract, not vigente, with antecipações, or with terms the M015 report cannot carry answers 409 RAIL_COMMAND_CLOSE_CONTRADICTED and writes nothing. A Dataprev fault answers 503 or 504 and writes nothing; then only refused closes the row. accepted on a portability exclusion reads the contract once through consultar-emprestimo-trabalhador (Manual 005 v1.16 §3.2.1) and requires situação 2 (Excluído) with origemExclusao 5 (Exclusão por portabilidade): the row closes accepted under GW-BANCO-PORTABILIDADE-EXCLUIDA, the contract's saldo devedor obligation ends with a final 0.00, and consignado.portabilidade.efetivada goes out with the destination and número único the request carried. The bank's statement overrides the read's informacoesPortabilidade block and when the exclusion was stamped; another contract, another situação or origem, or HY answers 409 RAIL_COMMAND_CLOSE_CONTRADICTED. response_message keeps who closed it and what the portal showed ("Fechado pelo banco por <subject>: <portal_evidence>"), and the board shows it. Never write a worker's CPF or name in portal_evidence: evidence that is blank once trimmed, holds a control character, or holds an 11-digit run (dots and dash optional) passing the CPF check digits answers 422 and reaches nothing. A caller whose identity names no subject answers 401. Sending the same statement again, by the same subject, answers 204 and changes nothing. Anything else on a closed row, an invoking row, a row parked under five minutes ago (a Dataprev answer may still be in flight), or a command of another kind (suspensão, reativação, antecipação de parcela, the reversal, legado inclusão and exclusão) answers 409 RAIL_COMMAND_NOT_CLOSEABLE, including a row the recovery pass closed first. An id this tenant does not hold answers 404. The tenant comes from the validated identity, never from the request.

POST /v1/consignado/rail-commands/{id}/close

Close a parked refinanciamento, renegociação, alteração, legado renegociação or portability exclusion by what the Dataprev portal shows

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/rail-commands/{id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "outcome": "accepted",
  "portal_evidence": "Portal Dataprev 28/10 14:05: contrato ativo, origem refinanciamento"
}
'

404

{
  "code": "AUT-0033",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string<uuid> · required

The rail command's id, as GET /v1/consignado/rail-commands lists it.

Example:

"0192f1a0-0000-7000-8000-00000000c101"

Body

application/json

outcome · enum<string> · required

What the Dataprev portal shows: accepted, the new contract exists or the contract left by portability; refused, it does not.

Available options: accepted, refused

Example:

"accepted"

portal_evidence · string · required

What the operator saw on the portal, 1 to 500 characters, trimmed, no control characters. Kept on the row; never a worker's CPF or name (a CPF answers 422).

Required string length: 1 - 500

Pattern: \S

Example:

"Portal Dataprev 28/10 14:05: contrato ativo, origem refinanciamento"

Response

204

No Content