Registrar baixa de fatura
/v1/faturas/baixasRegistra a baixa (quitação) de uma fatura de operadora. Endpoint em homologação: valide o fluxo antes de usar em produção.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino. É ele que define para qual operadora a requisição é encaminhada. Ex.: SulAmérica 01685053000156.
ex: 01685053000156Request Body
application/jsonrequired
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": {
"codigo": "1234",
"acesso": {
"usuario": "robo-rpa",
"senha": "***"
}
}
}Responses
Baixa registrada.
Resultado de uma operação, de consulta ou de escrita. Reúne o retorno da operadora, as validações de negócio e os dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado; cada operação popula um subconjunto dos campos. Eles são repassados como a operadora os envia: quais vêm preenchidos, e com que valor, é decisão dela e pode variar por operadora e por operação.
Em consulta por CPF é o vínculo mais recente (maior dataExclusao). Em escrita é a vida enviada; em lote, a primeira delas.
Igual ao protocolo.
INCLUSAO, EXCLUSAO, ...
Emitida quando a movimentação é liberada pela operadora.
Matrícula da família na operadora. Comportamento observado na SulAmérica (homologação): nas respostas de consulta é aqui que vem o valor exigido na exclusão como matriculaEmpresa.
Matrícula na operadora, exigida na exclusão como matriculaEmpresa. GUARDE o valor devolvido na inclusão. Comportamento observado na SulAmérica (homologação): nas consultas este campo volta nulo e o mesmo valor aparece em matriculaFamilia.
Todos os vínculos do CPF consultado, na ordem em que a operadora devolveu. beneficiario é o mais recente desta lista; use vinculos quando precisar dos outros ou de escolher por outro critério.
O vínculo ativo vem com dataExclusao igual a 9999-12-31, e não nula. A operadora não devolve a lista ordenada, então o último item não é necessariamente o mais recente.
Vem vazia quando a consulta não foi por CPF, quando o CPF informado não identifica uma pessoa (dígito repetido) ou quando os registros devolvidos não são todos da mesma pessoa.
items
Um item por vida enviada, na inclusão (o único movimento que aceita várias vidas). Cada entrada traz o codigoMovimentacao (protocolo) daquela vida.
Vem vazia em consulta, alteração e exclusão, que movimentam uma vida só.
protocolo e beneficiario no topo seguem apontando para a primeira vida, por compatibilidade. Em lote, use esta lista.
items
Validações retornadas pela operadora. A mensagem de cada uma marca a severidade das críticas que ela agrupa: "Critica Bloqueante" (rejeição) ou "Critica Não Bloqueante" (aviso; a movimentação segue o fluxo).
items
items
Erros críticos de regra de negócio.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
URI exata da operadora chamada (auditoria).
Eco do payload enviado à operadora (auditoria/troubleshooting), com credenciais sempre mascaradas (***); login/senha nunca são ecoados.
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Corpo da requisição acima do limite aceito pela fachada: 1 MB nas rotas de dados, 12 MB em POST /v1/faturas/interpretacoes, que recebe o PDF em base64.
Não há limite de ITENS no lote: o teto é de bytes, e existe para que um corpo gigante não derrube o processo. Lote grande que estoure o limite deve ser dividido em requisições; cada uma é independente na operadora.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Não foi possível concluir a operação junto à operadora.
Em consulta, sem repetir no corpo a falha pode ser transitória e nova tentativa é segura.
Em escrita (POST, PATCH, DELETE) o corpo traz repetir: false, e o desfecho é indeterminado: a operadora pode ter processado e só a resposta ter se perdido. Não reenvie. Se o corpo trouxer protocolo, consulte-o em GET /v1/movimentacoes/{protocolo}; se não, confira o beneficiário pelo CPF antes de tentar de novo.
Erro gerado pela própria API, antes ou depois de falar com a operadora. Formato distinto do Erro, que é usado quando o desfecho vem da operadora.
Motivo resumido.
Detalhe técnico, quando existe.
Quando false, não reenvie. Em consulta significa que repetir devolve o mesmo resultado; em escrita significa que o desfecho é indeterminado, porque a operadora pode ter processado e só a resposta ter se perdido. Ausente quando a falha pode ser transitória, o que só ocorre em consulta.
Protocolo da movimentação, quando a operadora devolveu um antes de falhar. **Em escrita com 502, consulte este protocolo em GET /v1/movimentacoes/{protocolo} em vez de reenviar.**
Caminho chamado na operadora, sem host. Para diagnóstico.
Resposta da operadora, para diagnóstico. Formato variável.
Outro status de transporte, repassado da operadora como veio (ex. 403, 404, 409, 429).
Não são desfecho de negócio. Rejeição da operadora chega em HTTP 200 com criticas; ausência de registro também é 200. Um status aqui indica problema de integração, não de cadastro, e vale acionar o suporte.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Registrar baixa de fatura
/v1/faturas/baixasRegistra a baixa (quitação) de uma fatura de operadora. Endpoint em homologação: valide o fluxo antes de usar em produção.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino. É ele que define para qual operadora a requisição é encaminhada. Ex.: SulAmérica 01685053000156.
ex: 01685053000156Request Body
application/jsonrequired
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": {
"codigo": "1234",
"acesso": {
"usuario": "robo-rpa",
"senha": "***"
}
}
}Responses
Baixa registrada.
Resultado de uma operação, de consulta ou de escrita. Reúne o retorno da operadora, as validações de negócio e os dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado; cada operação popula um subconjunto dos campos. Eles são repassados como a operadora os envia: quais vêm preenchidos, e com que valor, é decisão dela e pode variar por operadora e por operação.
Em consulta por CPF é o vínculo mais recente (maior dataExclusao). Em escrita é a vida enviada; em lote, a primeira delas.
Igual ao protocolo.
INCLUSAO, EXCLUSAO, ...
Emitida quando a movimentação é liberada pela operadora.
Matrícula da família na operadora. Comportamento observado na SulAmérica (homologação): nas respostas de consulta é aqui que vem o valor exigido na exclusão como matriculaEmpresa.
Matrícula na operadora, exigida na exclusão como matriculaEmpresa. GUARDE o valor devolvido na inclusão. Comportamento observado na SulAmérica (homologação): nas consultas este campo volta nulo e o mesmo valor aparece em matriculaFamilia.
Todos os vínculos do CPF consultado, na ordem em que a operadora devolveu. beneficiario é o mais recente desta lista; use vinculos quando precisar dos outros ou de escolher por outro critério.
O vínculo ativo vem com dataExclusao igual a 9999-12-31, e não nula. A operadora não devolve a lista ordenada, então o último item não é necessariamente o mais recente.
Vem vazia quando a consulta não foi por CPF, quando o CPF informado não identifica uma pessoa (dígito repetido) ou quando os registros devolvidos não são todos da mesma pessoa.
items
Um item por vida enviada, na inclusão (o único movimento que aceita várias vidas). Cada entrada traz o codigoMovimentacao (protocolo) daquela vida.
Vem vazia em consulta, alteração e exclusão, que movimentam uma vida só.
protocolo e beneficiario no topo seguem apontando para a primeira vida, por compatibilidade. Em lote, use esta lista.
items
Validações retornadas pela operadora. A mensagem de cada uma marca a severidade das críticas que ela agrupa: "Critica Bloqueante" (rejeição) ou "Critica Não Bloqueante" (aviso; a movimentação segue o fluxo).
items
items
Erros críticos de regra de negócio.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
URI exata da operadora chamada (auditoria).
Eco do payload enviado à operadora (auditoria/troubleshooting), com credenciais sempre mascaradas (***); login/senha nunca são ecoados.
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Corpo da requisição acima do limite aceito pela fachada: 1 MB nas rotas de dados, 12 MB em POST /v1/faturas/interpretacoes, que recebe o PDF em base64.
Não há limite de ITENS no lote: o teto é de bytes, e existe para que um corpo gigante não derrube o processo. Lote grande que estoure o limite deve ser dividido em requisições; cada uma é independente na operadora.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Não foi possível concluir a operação junto à operadora.
Em consulta, sem repetir no corpo a falha pode ser transitória e nova tentativa é segura.
Em escrita (POST, PATCH, DELETE) o corpo traz repetir: false, e o desfecho é indeterminado: a operadora pode ter processado e só a resposta ter se perdido. Não reenvie. Se o corpo trouxer protocolo, consulte-o em GET /v1/movimentacoes/{protocolo}; se não, confira o beneficiário pelo CPF antes de tentar de novo.
Erro gerado pela própria API, antes ou depois de falar com a operadora. Formato distinto do Erro, que é usado quando o desfecho vem da operadora.
Motivo resumido.
Detalhe técnico, quando existe.
Quando false, não reenvie. Em consulta significa que repetir devolve o mesmo resultado; em escrita significa que o desfecho é indeterminado, porque a operadora pode ter processado e só a resposta ter se perdido. Ausente quando a falha pode ser transitória, o que só ocorre em consulta.
Protocolo da movimentação, quando a operadora devolveu um antes de falhar. **Em escrita com 502, consulte este protocolo em GET /v1/movimentacoes/{protocolo} em vez de reenviar.**
Caminho chamado na operadora, sem host. Para diagnóstico.
Resposta da operadora, para diagnóstico. Formato variável.
Outro status de transporte, repassado da operadora como veio (ex. 403, 404, 409, 429).
Não são desfecho de negócio. Rejeição da operadora chega em HTTP 200 com criticas; ausência de registro também é 200. Um status aqui indica problema de integração, não de cadastro, e vale acionar o suporte.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.