Pular para conteúdo

Resultados das inclusões

Este endpoint tem como objetivos:

  • Permitir descobrir se a inclusão ou exclusão teve algum erro ou se foi bem sucedida.
  • Comunicar algum aviso sobre a inclusão. Por exemplo, que não foi encontrado o endereço informado.
  • Informar caso ocorra alguma alteração no status da negativação. Por exemplo, uma baixa por descurso do prazo legal de 5 anos ou por ordem judicial.
  • Informar se o registro está aguardando a sincronização com a Serasa ou se já foi feito.
  • Informar se a Serasa já retornou o resultado do processamento do registro.

Este endpoint só aceita o método GET, portanto, todas as informações que nele contém, são apenas de leitura e gerada pelo sistema de acordo com a alimentação das informações geradas pelo processamento dos registros pefin.

Normalmente o processo de processamento do pefin ocorre pela manhã, e uma vez ao dia, portanto, requisições em loop ou feita com muita frequência está sujeito a ser bloqueado por uso indevido do sistema.

Um novo registro é criado nesse endpoint em 3 situações diferentes:

  • Ao cadastrar um novo coobrigado ou dívida.
  • Ao dar baixa em uma dívida ou em um coobrigado (caso tenha dado baixa nos 2 simultaneamente irá aparecer apenas a dívida)
  • Quando ocorre algum evento vindo da Serasa e o cliente precisa ser notificado, normalmente vem como uma "Condição especial"

Endpoint: https://homolog-pefin.targetinformacoes.com/results/

Campos

Campo Tipo Observacao
pk String/UUID Identifica de forma única o registro.
operation String Identifica o tipo de operação (C, E, I).
document String Número do documento do coobrigado ou do negativado.
name String Nome do negativado ou do coobrigado.
contract String Número do contrato da dívida.
amount Decimal Valor da dívida.
typeInclusion String (g/d) Tipo do registro processado: "g" para coobrigado ou "d" para dívida
statusCode Array Array de String com o retorno do processamento do registro, os retornos possíveis são descritos em dícionário de dados e cada elemento tem 3 posições.
isGenerate Boolean Caso seja true, já foi iniciado o processo de sincronização com a Serasa, false, significa que o registro está na fila para ser processado e sincronizado.
isReceived Boolean Caso seja true, significa que o processo de sincronização com a Serasa foi concluído e caso o statusCode esteja nulo significa que deu tudo certo. Se estiver como false, significa que está aguardando o retorno/resultado do processamento.

Existem 3 tipos de operações distintos, que são gerados em determinados eventos:

Abreviação Nome Descrição
C Condição especial Esse evento é gerado pera Serasa. Ocorre quando tem alguma alteração ou atualização do registro para informar ao usuário ou o sistema, por exemplo, uma baixa que foi feito usando diretamente o sistema da Serasa, ou que a Serasa foi obrigada a fazer para cumprir uma ordem judicial, ate algo mais simples, como um aviso que o Correios não encontrou o endereço informado e portanto a Carta não foi entregue, sendo este último, o principal gerador deste evento.
E Exclusão Quando é feito uma baixa de um coobrigado ou de uma dívida.
I Inclusão Quando é feito a inclusão de uma dívida ou de um coobrigado

Filtros disponíveis

Existe alguns filtros nesse endpoint para facilitar o acompanhamento, eles são passados via parâmetros na URL.

Exemplo: https://homolog-pefin.targetinformacoes.com/results/?document=85261173000&contract=74338d49a

Campo Descrição
document Número do documento do coobrigado ou do negativado
contract Número do contrato da dívida
debt PK do débito que queira consultar
guarantor PK do coobrigado que queira consultar

Listando os registros

Endpoint: https://homolog-pefin.targetinformacoes.com/results/

Listando os registros
curl -X GET --location "https://homolog-pefin.targetinformacoes.com/results/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "createdAt": "2022-07-06T15:53:41.445841-03:00",
      "operation": "E",
      "contract": "185098",
      "amount": 49.99,
      "document": "85261173000",
      "name": "Roberto Elias Cauã Moura",
      "typeInclusion": "g",
      "statusCode": null,
      "isGenerate": false,
      "isReceived": false,
      "pk": "94338d49-e25f-498e-a17b-db96b948dbc5"
    },
    {
      "createdAt": "2022-07-06T13:53:37.782116-03:00",
      "operation": "I",
      "contract": "185098",
      "amount": 49.99,
      "document": "72213046000108",
      "name": "Laura e Juan Locações de Automóveis ME",
      "typeInclusion": "g",
      "statusCode": [
        "291"
      ],
      "isGenerate": true,
      "isReceived": true,
      "pk": "b0d076e1-c26d-4385-97db-49ec12cbb994"
    }
  ]
}