MDSAPI Portal/IZII MDS — Orquestrador de Benefícios (REST)
post

Registrar baixa de fatura

/v1/faturas/baixas

Registra a baixa (quitação) de uma fatura de operadora.

Headers

X-Cnpj-Provedorstringrequired

CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.

Request Body

application/jsonrequired

object
cnpjClientestring
contratoobject
codigostring
acessoobject
usuariostring
senhastring
Ver schema bruto / exemplo JSON
{
  "cnpjCliente": "33055146000193",
  "contrato": {
    "codigo": "1234",
    "acesso": {
      "usuario": "robo-rpa",
      "senha": "***"
    }
  }
}

Responses

201

Baixa registrada.

object

Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.

statusinteger

Código HTTP resultante do processamento na operadora.

protocolostring

Protocolo de rastreio gerado pela operadora.

statusMovimentacaostring
beneficiarioobject

Resumo do beneficiário afetado.

nomestring
cpfstring
numeroCarteirinhastring
validacoesarray

Validações/avisos retornados pela operadora.

items

object
nomeBeneficiariostring
matriculaFuncionariostring
sequencialinteger
codigostring
mensagemstring
criticasarray

Erros críticos de regra de negócio.

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring
requestURIstring

URI exata da operadora chamada (auditoria).

requestJsonobject

Payload exato enviado à operadora (auditoria/troubleshooting).

responseContentobject

Retorno cru (raw) devolvido pela API da operadora.

400

Requisição malformada (campos obrigatórios ausentes/ inválidos).

object

Estrutura padronizada de erro.

statusinteger

Código HTTP do erro.

codigostring

Código interno do erro.

mensagemstring

Descrição legível do erro.

criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring
401

Token ausente, expirado ou inválido.

object

Estrutura padronizada de erro.

statusinteger

Código HTTP do erro.

codigostring

Código interno do erro.

mensagemstring

Descrição legível do erro.

criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring