SNP Cartório

Estimated reading: 4 minutes 16 views

Esta documentação orienta os desenvolvedores de cartórios e sistemas integrados ao CRA21 no uso da API da Solução de Negociação Prévia (SNP).

Autenticação e Ambientes

Autenticação

A autenticação da API utiliza o método Basic Auth, com as mesmas credenciais (login e senha) usadas no sistema CRA21. Usuários do webservice SOAP podem usar as mesmas credenciais.

Ambientes

A API está disponível em dois ambientes:

Homologação (Testes):: https://uf.hm.craapi.com.br
Produção (Operacional):: https://crauf.api.crabr.com.br

SNP Cartório – Títulos com Negociação

Busca de Dados Complementares

Ao identificar que o título está na SNP (letra “X” no campo 48 – Tipo/Motivo do Protesto), esta API deve ser acionada para obtenção dos seguintes dados:

Valor da negociação: negociacao.valorNegociacao
Data limite para pagamento: negociacao.dataLimitePagamento
Contatos do devedor: devedores.email e devedores.telefone
Chave única Nacional: negociacao.chaveUnicaNacional
Data do movimento SNP: negociacao.dataPedido
Endereço completo do devedor: devedores.endereco.enderecoCompleto
Cobrança antecipada: negociacao.cobrancaAntecipada (“S” ou “N”)

Busca de Status do Processo de Negociação

Para acompanhar o status, consulte o campo negociacao.historico.codigo. Os códigos que indicam finalização são:

Código 11 – Acordo firmado: Devedor pagou na SNP. Custas serão creditadas.
Código 12 – Negociação cancelada: Equivalente a retirada indevida. Cartório não receberá custas.
Código 13 – Negociação frustrada: O título deve seguir o fluxo de protesto.
Código 14 – Negociação finalizada: Título retirado da SNP. Custas serão creditadas.

Orientação de Implementação

Use o serviço GET /negociacao para consultar o campo negociacao.historico.codigo.
Armazene o último código de histórico registrado em seu sistema.
A consulta à API deve ser realizada somente se o último status registrado não for um dos códigos de finalização (11, 12, 13 ou 14).
Recomenda-se realizar no máximo uma consulta por dia para evitar sobrecarga.

Serviço: GET /negociacao

Autorização: basicAuth (HTTP Basic)

Query Parameters

Parâmetro	Descrição e Sugestão de Uso
`chaveUnicaNacional`	Filtra pela chave exata. (Sugestão: buscar atualização de uma negociação específica).
`dataPedidoSnp`	Filtra pela data do pedido (Ex: `10012024`).
`dataHistorico`	Filtra pela data do histórico. (Sugestão: listar títulos que tiveram atualização na data).
`dataRemessa`	Filtra pela data de remessa do título. (Sugestão: buscar dados complementares no processamento da remessa).
`protocolo`	Filtra pelo protocolo exato do título.
`dataProtocolo`	Filtra pela data do protocolo do título (Ex: `10012024`).

Exemplo de Resposta (200 OK)

{
    "_links": {
        "self": {}
    },
    "_embedded": {
        "titulos": []
    },
    "total_items": 1
}

Tabelas de Referência

Tabela de Ocorrências de Negociação

Código	Descrição
01	Proposta enviada ao devedor.
02	Proposta aceita pelo devedor.
03	Proposta recusada pelo devedor.
04	Contraproposta realizada pelo devedor.
05	Contraproposta aceita pelo credor.
06	Contraproposta recusada pelo credor.
07	Contraproposta realizada pelo credor.
08	Contraproposta aceita pelo devedor.
09	Contraproposta recusada pelo devedor.
10	Negociação iniciada – aguardando pagamento.
11	Acordo firmado – indica que o devedor pagou o título na SNP. O valor das custas será creditado na conta do cartório.
12	Negociação cancelada – equivale a retirada por remessa indevida. O processo foi interrompido e o cartório não receberá as custas.
13	Negociação frustrada – o título deve seguir o fluxo de protesto.
14	Negociação finalizada – o título foi retirado da SNP. O valor das custas será creditado na conta do cartório.

Códigos HTTP Retornados

Código HTTP	Descrição
200 OK	Requisição processada com sucesso.
201 Created	Recurso criado com sucesso.
400 Bad Request	A requisição possui erros de sintaxe ou campos inválidos.
401 Unauthorized	Falha de autenticação, verifique suas credenciais.
403 Forbidden	Permissão negada para acessar o recurso solicitado.
404 Not Found	Recurso não encontrado ou inexistente.
409 Conflict	O recurso já existe ou está em um estado conflitante.
422 Unprocessable Entity	Dados válidos, mas não processáveis devido a regras de negócio.
500 Internal Server Error	Erro inesperado no servidor.