Após ser realizado o processo de Solicitação de Negativação, processo visto na etapa anterior, você irá receber um protocolo referente a consulta.
Primeiramente, você utilizou uma rota POST para realizar a solicitação, e recebeu um protocolo referente a este pedido, neste artigo iremos ver sobre o método da realização da consulta do protocolo.
Em posse de seu protocolo, você utiliza uma rota GET para fazer a consulta.
Definição da Requisição
A solicitação é feita através de uma requisição GET. A rota chamada deve ter a seguinte URL:
QueryString
Produção:
https://api.consultanegativacao.com.br/v1/negativacao?protocolo=[protocolo obtido na requisição anterior]
Homologação:
https://api.consultanegativacao.com.br/v1/homologacao/negativacao?protocolo=[protocolo obtido na requisição anterior]
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 | 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 |
Retornos
Em caso de sucesso:
- Status code 200:
{
"protocolo": "string",
"motivo": "string",
"cnpjCredor": "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"
},
"historico": [
{
"valor": 0,
"tipoHistorico": "string",
"usuario": "string"
}
]
}
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.
Comentários
0 comentário
Por favor, entre para comentar.