O processo de Negativação é realizado de forma assíncrona.
Primeiramente você utiliza esta rota POST para realizar a solicitação, e recebe um protocolo referente a este pedido.
E na sequência, em posse de seu protocolo, você utiliza a rota GET (que veremos no próximo post) para fazer a consulta do protocolo.
Definição da Requisição
A solicitação é feita através de uma requisição POST. A rota chamada deve ter a seguinte URL:
Produção:
https://api.consultanegativacao.com.br/v1/negativacao
Homologação:
https://api.consultanegativacao.com.br/v1/homologacao/negativacao
Headers
| Nome | Descrição | Exemplo |
| cnpjSH | CNPJ da Software House que possui contrato com a Tecnospeed | 01001001000113 |
| tokenSH | Token da Software House que possui contrato com a Tecnospeed | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpjUsuario | CNPJ do cliente que irá disparar as consultas e será o credor da negativação | 01001001000113 |
| login | Login disponibilizado pela SCC Check após a assinatura do contrato | Ex.: Usuário01 |
| password | Senha disponibilizada pela SCC Check após a assinatura do contrato | Ex.: 123@mudar |
Obs.: A requisição de negativação não possui URL específica para homologação. Para utilizar em ambiente de testes, utilize os headers de testes disponibilizados pela Tecnospeed.
Body
Este é o json que deve ser enviado no body da requisição (como application/json)
{
"nome": "string",
"documento": "string",
"endereco": "string",
"enderecoComplemento": "string",
"bairro": "string",
"municipio": "string",
"uf": "string",
"cep": "string",
"divida": {
"nossoNumero": "string",
"especieTitulo": "1",
"numDocumento": "string",
"dataEmissao": "string",
"dataVencimento": "string",
"valorTitulo": 0,
"numAgencia": "string",
"numConta": "string",
"codBanco": "string",
"numCheque": "string",
"codAlinea": "12",
"codEndosso": "1",
"codAceite": "1"
}
}
Definição dos campos do body da requisição:
| Campo | Descrição | Obrigatório/Observação |
|
nome |
Nome completo do devedor, sem abreviações. | Sim. |
|
documento |
Numeração do documento do devedor. | Sim. |
|
endereco |
Endereço completo do devedor, contendo o número. | Sim. |
|
enderecoComplemento |
Complemento do endereço do devedor, quando existir. | Não. |
|
bairro |
Bairro do devedor. | Sim. |
|
municipio |
Município do devedor. | Sim. |
|
uf |
Sigla da unidade federativa do devedor. | Sim. |
|
cep |
CEP do endereço do devedor. | Sim. |
|
nossoNumero |
Número de identificação do devedor. | Sim. |
|
especieTitulo |
Código do tipo de documento da dívida. Códigos e Descrição: 1: Diversos quando não enquadrar na relação. |
Sim. |
|
numDocumento |
Número do documento que foi emitido e que se caracteriza como título vencido. | Sim. |
|
dataEmissao |
Data em que o documento que caracteriza o débito foi emitido. | Sim. Obs.: O formato da data deverá ser Ano-Mês-Dia. Exemplo: 2018-11-30 |
|
dataVencimento |
Data de vencimento do documento. |
Sim. Obs.: O documento deve estar vencido no mínimo a 5 dias e no máximo a 5 anos. O formato da data deverá ser Ano-Mês-Dia. Exemplo: 2018-11-30. |
|
valorTitulo |
Valor exato do documento. | Sim. Obs.: Valor sem multa e sem juros. |
|
numAgencia |
Número da agência do cheque. |
Obs.: Obrigatório apenas quando o código do tipo do documento da dívida for igual a 2. Informar somente números. |
|
numConta |
Número da conta do cheque. |
Obs.: Obrigatório apenas quando o código do tipo do documento da dívida for igual a 2. Informar somente números. |
|
codBanco |
Código do banco do cheque. |
Obs.: Obrigatório apenas quando o código do tipo do documento da dívida for igual a 2. Informar somente números. |
|
numCheque |
Número do cheque. |
Obs.: Obrigatório apenas quando o código do tipo do documento da dívida for igual a 2. Informar somente números. |
|
codAlinea |
Código da Alínea. Se trata do "problema", o motivo da devolução do cheque. Códigos e Descrição: 12: Insuficiência de fundos - 2ª apresentação. |
Obs.: Obrigatório apenas quando o "especieTitulo" for igual a 2 (Cheque).
Informar somente números. |
|
codEndosso |
Código do tipo do Endosso. Utilizado quando existe um avalista na dívida. Códigos e Descrição: 1: Mandato.
|
Sim. |
|
codAceite |
Código do Aceite. Códigos e Descrição: 1: Aceitos. |
Sim. |
Retornos
Em caso de sucesso:
- Status code 200:
{ "protocolo": "string", "cnpjCredor": "string", "motivo": "string", "nome": "string", "situacao": "string", "documento": "string", "endereco": "string", "enderecoComplemento": "string", "bairro": "string", "municipio": "string", "uf": "string", "cep": "string", "valor": "string", "divida": { "nossoNumero": "string", "especieTitulo": "string", "numDocumento": "string", "dataEmissao": "string", "dataVencimento": "string", "valorTitulo": 0, "numAgencia": "string", "numConta": "string", "codBanco": "string", "numCheque": "string", "codEndosso": "string", "codAlinea": "string", "codAceite": "string"
}
}
Obs.: Ao receber um statusCode 200 na requisição, é de extrema importância que o protocolo retornado seja salvo, pois o acompanhamento do processo de negativação depende inteiramente da consulta deste protocolo.
Obs. 2: A confirmação de uma negativação, feita pela Serasa, leva cerca de 15 dias. No próximo post, onde detalharemos a rota de consulta, você verá com mais detalhes como acompanhar este processo.
Em caso de erro:
- StatusCode: 422
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "string",
"internalCode": 0
}
]
}
- StatusCode: 401
{
{
"code": 401,
"message": "Unprocessable Entity"
}
}
Nos retornos acima, o objeto "errors" trará a listagem de erros que poderão ter ocorrido na solicitação da consulta. E o campo "message" trará uma mensagem informando o motivo do erro.
Obs.: O processo de negativação é realizado utilizando os serviços de consulta oferecidos pela SCC Check, parceira da Tecnospeed nas consultas.
Feito com amor pela Comunicação
Comentários
0 comentário
Por favor, entre para comentar.