PEFIN | Manual de Integração

Manual de Integração

SERASA - PEFIN (Pendências Financeiras)

Webservices SERASA

Endpoints

Produção: http://www.soawebservices.com.br/webservices/producao/serasa/pefin.asmx

Test-Drive: http://www.soawebservices.com.br/webservices/test-drive/serasa/pefin.asmx

Método: PEFIN

Descrição: Retorna consulta de pendências financeiras na SERASA

Headers:

POST /webservices/producao/serasa/pefin.asmx HTTP/1.1
Host: www.soawebservices.com.br
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "SOAWebServices/Pefin"

Requisição SEM solicitar adicionais SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Pefin xmlns="SOAWebServices">
      <Credenciais>
        <Email>string</Email>
        <Senha>string</Senha>
      </Credenciais>
      <Documento>string</Documento>
    </Pefin>
  </soap:Body>
</soap:Envelope>

Resposta SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PefinResponse xmlns="SOAWebServices">
      <PefinResult>
        <SinteseCadastral>
          <Documento>string</Documento>
          <Nome>string</Nome>
          <NomeMae>string</NomeMae>
          <NomeFantasia>string</NomeFantasia>
          <DataNascimento>string</DataNascimento>
          <DataFundacao>string</DataFundacao>
          <SituacaoRFB>string</SituacaoRFB>
          <SituacaoDescricaoRFB>string</SituacaoDescricaoRFB>
          <DataSituacaoRFB>string</DataSituacaoRFB>
        </SinteseCadastral>
        <TotalOcorrencias>int</TotalOcorrencias>
        <ValorTotalOcorrencias>string</ValorTotalOcorrencias>
        <AlertaDocumentos>
          <NumeroMensagem>string</NumeroMensagem>
          <TotalMensagens>string</TotalMensagens>
          <TipoDocumento>string</TipoDocumento>
          <NumeroDocumento>string</NumeroDocumento>
          <MotivoOcorrencia>string</MotivoOcorrencia>
          <DataOcorrencia>string</DataOcorrencia>
          <TelefonesContato>
            <Telefone>string</Telefone>
          </TelefonesContato>
          <TelefonesContato>
            <Telefone>string</Telefone>
          </TelefonesContato>
          <Mensagem>string</Mensagem>
        </AlertaDocumentos>
        <PendenciasInternas>
          <TotalOcorrencias>int</TotalOcorrencias>
          <OcorrenciaMaisAntiga>string</OcorrenciaMaisAntiga>
          <OcorrenciaMaisRecente>string</OcorrenciaMaisRecente>
          <ValorTotalOcorrencias>string</ValorTotalOcorrencias>
          <PendenciasIternasDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <Modalidade>string</Modalidade>
            <Avalista>string</Avalista>
            <TipoMoeda>string</TipoMoeda>
            <Valor>decimal</Valor>
            <Contrato>string</Contrato>
            <Origem>string</Origem>
          </PendenciasIternasDetalhe>
          <PendenciasIternasDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <Modalidade>string</Modalidade>
            <Avalista>string</Avalista>
            <TipoMoeda>string</TipoMoeda>
            <Valor>decimal</Valor>
            <Contrato>string</Contrato>
            <Origem>string</Origem>
          </PendenciasIternasDetalhe>
          <Mensagem>string</Mensagem>
        </PendenciasInternas>
        <PendenciasFinanceiras>
          <TotalOcorrencias>int</TotalOcorrencias>
          <OcorrenciaMaisAntiga>string</OcorrenciaMaisAntiga>
          <OcorrenciaMaisRecente>string</OcorrenciaMaisRecente>
          <ValorTotalOcorrencias>string</ValorTotalOcorrencias>
          <PendenciasFinanceirasDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <Modalidade>string</Modalidade>
            <Avalista>string</Avalista>
            <TipoMoeda>string</TipoMoeda>
            <Valor>string</Valor>
            <Contrato>string</Contrato>
            <Origem>string</Origem>
            <Sigla>string</Sigla>
            <SubJudice>string</SubJudice>
            <SubJudiceDescricao>string</SubJudiceDescricao>
            <TipoAnotacao>string</TipoAnotacao>
            <TipoAnotacaoDescricao>string</TipoAnotacaoDescricao>
          </PendenciasFinanceirasDetalhe>
          <PendenciasFinanceirasDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <Modalidade>string</Modalidade>
            <Avalista>string</Avalista>
            <TipoMoeda>string</TipoMoeda>
            <Valor>string</Valor>
            <Contrato>string</Contrato>
            <Origem>string</Origem>
            <Sigla>string</Sigla>
            <SubJudice>string</SubJudice>
            <SubJudiceDescricao>string</SubJudiceDescricao>
            <TipoAnotacao>string</TipoAnotacao>
            <TipoAnotacaoDescricao>string</TipoAnotacaoDescricao>
          </PendenciasFinanceirasDetalhe>
          <Mensagem>string</Mensagem>
        </PendenciasFinanceiras>
        <PendenciasBacen>
          <TotalOcorrencias>int</TotalOcorrencias>
          <OcorrenciaMaisAntiga>string</OcorrenciaMaisAntiga>
          <OcorrenciaMaisRecente>string</OcorrenciaMaisRecente>
          <Banco>string</Banco>
          <Agencia>string</Agencia>
          <NomeFantasiaBanco>string</NomeFantasiaBanco>
          <PendenciasBacenDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <NumeroCheque>string</NumeroCheque>
            <AlineaCheque>string</AlineaCheque>
            <QuantidadeCCFBanco>string</QuantidadeCCFBanco>
            <Valor>string</Valor>
            <Banco>string</Banco>
            <NomeBanco>string</NomeBanco>
            <Agencia>string</Agencia>
            <Cidade>string</Cidade>
            <UF>string</UF>
          </PendenciasBacenDetalhe>
          <PendenciasBacenDetalhe>
            <DataOcorrencia>string</DataOcorrencia>
            <NumeroCheque>string</NumeroCheque>
            <AlineaCheque>string</AlineaCheque>
            <QuantidadeCCFBanco>string</QuantidadeCCFBanco>
            <Valor>string</Valor>
            <Banco>string</Banco>
            <NomeBanco>string</NomeBanco>
            <Agencia>string</Agencia>
            <Cidade>string</Cidade>
            <UF>string</UF>
          </PendenciasBacenDetalhe>
          <Mensagem>string</Mensagem>
        </PendenciasBacen>
        <Mensagem>string</Mensagem>
        <Status>boolean</Status>
        <Transacao>
          <Status>boolean</Status>
          <CodigoStatus>string</CodigoStatus>
          <CodigoStatusDescricao>string</CodigoStatusDescricao>
        </Transacao>
      </PefinResult>
    </PefinResponse>
  </soap:Body>
</soap:Envelope>

Requisição COM adicionais SOAP/XML:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Pefin xmlns="SOAWebServices">
      <Credenciais>
        <Email>string</Email>
        <Senha>string</Senha>
      </Credenciais>
      <Documento>string</Documento>
       <soaw:Adicionais>
            <!--Voce pode solicitar qualquer um dos adicionais ou todos -->
            <!-- Para Pessoas Fisicas -->
            <soaw:ItemAdicional>Participacoes</soaw:ItemAdicional>
            <soaw:ItemAdicional>RiskScoring</soaw:ItemAdicional>
            <soaw:ItemAdicional>LimiteCredito</soaw:ItemAdicional>
            <!-- Para Pessoas Juridicas -->
            <soaw:ItemAdicional>QuadroDeSocios</soaw:ItemAdicional>
            <soaw:ItemAdicional>Participacoes</soaw:ItemAdicional>
            <soaw:ItemAdicional>RiskScoring</soaw:ItemAdicional>
            <soaw:ItemAdicional>LimiteCredito</soaw:ItemAdicional>            
         </soaw:Adicionais>
    </Pefin>
  </soap:Body>
</soap:Envelope>

Obs: Quando solicitado os adicionais serão cobrados alem do valor da consulta, verifique no portal o preço de cada adicional.

Exemplo de Resposta com Adicionais SOAP/XML:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <PefinResponse xmlns="SOAWebServices">
         <PefinResult>
            <SinteseCadastral>
               <Documento>11111111111</Documento>
               <Nome>GLEDE BERNACCI GOLLUSCIO</Nome>
               <NomeMae>INEZ DAINESE BERNACCI</NomeMae>
               <DataNascimento>23/01/1938</DataNascimento>
               <SituacaoRFB>9</SituacaoRFB>
               <SituacaoDescricaoRFB>CANCELADO</SituacaoDescricaoRFB>
               <DataSituacaoRFB>06/05/2013</DataSituacaoRFB>
            </SinteseCadastral>
            <TotalOcorrencias>0</TotalOcorrencias>
            <ValorTotalOcorrencias>0,00</ValorTotalOcorrencias>
            <AlertaDocumentos>
               <Mensagem>NAO CONSTAM OCORRENCIAS</Mensagem>
            </AlertaDocumentos>
            <PendenciasInternas>
               <TotalOcorrencias>0</TotalOcorrencias>
               <Mensagem>NAO CONSTAM OCORRENCIAS</Mensagem>
            </PendenciasInternas>
            <PendenciasFinanceiras>
               <TotalOcorrencias>0</TotalOcorrencias>
               <Mensagem>NAO CONSTAM OCORRENCIAS</Mensagem>
            </PendenciasFinanceiras>
            <PendenciasBacen>
               <TotalOcorrencias>0</TotalOcorrencias>
               <Mensagem>NAO CONSTAM OCORRENCIAS</Mensagem>
            </PendenciasBacen>
            <Participacoes>
               <ParticipacaoSocietaria>
                  <Pessoa>Juridica</Pessoa>
                  <DocumentoEmpresa>56656119000171</DocumentoEmpresa>
                  <Empresa>HOMOLOGACAO CNPJ56656119000171 LTDA</Empresa>
                  <Percentual>0,00</Percentual>
                  <Estado>SP</Estado>
                  <DataUltimaAtualizacao>20/06/2007</DataUltimaAtualizacao>
               </ParticipacaoSocietaria>
            </Participacoes>
            <RiskScore>
               <PessoaFisica>
                  <Modelo>ZZ13</Modelo>
                  <Calculado>S</Calculado>
                  <Classe>AAA</Classe>
                  <PercentualInadimplentes>12</PercentualInadimplentes>
                  <Descricao>O Consumidor se insere em um grupo de pessoas cuja a probabilidade de pagamento é de 88% em um período de 12 meses.</Descricao>
               </PessoaFisica>
            </RiskScore>
            <LimiteCredito>
               <PessoaFisica>
                  <Valor>818,00</Valor>
                  <Observacoes>
                     <Item>ESPACO RESERVADO PARA MENSAGEM DA INSTITUICAO</Item>
                  </Observacoes>
               </PessoaFisica>
            </LimiteCredito>
            <Status>true</Status>
            <Transacao>
               <Status>true</Status>
               <CodigoStatus>G000M001</CodigoStatus>
               <CodigoStatusDescricao>Transacao realizada com sucesso</CodigoStatusDescricao>
            </Transacao>
         </PefinResult>
      </PefinResponse>
   </soap:Body>
</soap:Envelope>

Estrutura de Retorno do PEFIN:

Item

Tipo

Nome

Descrição

XML Node

SinteseCadastral

Sintese Cadastral

Integer

TotalOcorrencias

Quantidade de Restrições

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições

XML Node

AlertaDocumentos

Alerta de Documentos

XML Node

PendenciasInternas

Pendências Internas

XML Node

PendenciasFinanceiras

Pendências Financeiras

XML Node

PendenciasBacen

Pendências Bacen

XML Node

Transacao

Informações de Status da Transação

Boolean

Status

Veja nota, TAG irá ser descontinuado

varchar(80)

Mensagem

Veja nota, TAG irá ser descontinuado

Sintese Cadastral:

Item

Tipo

Nome

Descrição

1.1

varchar(8)

Documento

CPF da Pessoa

1.2

varchar(100)

Nome

Nome da Pessoa Física

1.3

varchar(100)

NomeMae

Nome da Mae em caso de PF

1.4

varchar(100)

NomeFantasia

Nome Fantasia em caso de PJ

1.5

Date

DataNascimento

Data de Nascimento (DD/MM/AAAA) em caso de PF

1.6

Date

DataFundacao

Data de Fundação (DD/MM/AAAA) em caso de PJ

1.7

Integer

SituacaoRFB

Codigo da Situação

1.8

varchar(20)

SituacaoDescricaoRFB

Descricao da Situação na RFB

1.9

Date

DataSituacaoRFB

Data da Situação (DD/MM/AAAA)

Situações Receita Federal:

0-Inapta

2-Ativa/Regular

3-Pendente de Regularizacao

4-Nao Disponivel

6-Suspenso(a)

7-Baixada

9-Cancelado

Nao Disponivel

Alerta de Documentos:

Item

Tipo

Nome

Descrição

XML Node

AlertaDocumentos

Node contendo informações sobre os alertas do documento consultado.

4.1

Integer

NumeroMensagem

Número da Mensagem

4.2

Integer

TotalMensagens

Total de Mensagens

4.3

varchar(6)

TipoDocumento

Tipo do Documento

4.4

varchar(20)

NumeroDocumento

Numero do Documento

4.5

varchar(4)

MotivoOcorrencia

Motivo da Ocorrencia

4.6

Date

DataOcorrencia

Data da Ocorrência (DD/MM/AAAA)

Telefones Contato:

Item

Tipo

Nome

Descrição

4.7

XML Node

TelefonesContato

Node contendo informações sobre o Telefone de Contato do Alerta.

4.7.1

varchar(8)

Telefone

Numero do Telefone

PendenciasInternas:

Item

Tipo

Nome

Descrição

5.1

Integer

TotalOcorrencias

Quantidade de Restrições deste bloco

5.2

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições deste bloco

5.3

Date

OcorrenciaMaisAntiga

Data da Ocorrencia Mais Antiga (DD/MM/AAAA)

5.4

Date

OcorrenciaMaisRecente

Data da Ocorrencia Mais Recente (DD/MM/AAAA)

5.5

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições

5.6

XML Node

PendenciasInternasDetalhe

Valor Total das Restrições

PendenciasInternasDetalhe:

Item

Tipo

Nome

Descrição

5.6.1

Date

DataOcorrencia

Data da Ocorrência

5.6.2

varchar(30)

Modalidade

Modalidade do Titulo

5.6.3

varchar(1)

Avalista

Avalista do Titulo

5.6.4

varchar(3)

TipoMoeda

Tipo de Moeda Ex: R$

5.6.5

numeric(18,2)

Valor

Valor o Titulo

5.6.6

varchar(16)

Contrato

Numero do Contrato

5.6.7

varchar(30)

Origem

Origem do Titulo

5.6.8

varchar(4)

Sigla

Sigla da Origem do Titulo

5.6.9

varchar(1)

SubJudice

SubJudice (S/N)

5.6.10

varchar(80)

SubJudiceDescricao

Descricao de SubJudice

5.6.11

varchar(1)

TipoAnotacao

Tipo de Anotação

5.6.12

varchar(100)

TipoAnotacaoDescricao

Descrição do Tipo de Anotação

Obs: Este node pode se repetir várias vezes

PendenciasFinanceiras:

Item

Tipo

Nome

Descrição

6.1

Integer

TotalOcorrencias

Quantidade de Restrições deste bloco

6.2

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições deste bloco

6.3

Date

OcorrenciaMaisAntiga

Data da Ocorrencia Mais Antiga (DD/MM/AAAA)

6.4

Date

OcorrenciaMaisRecente

Data da Ocorrencia Mais Recente (DD/MM/AAAA)

6.5

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições

6.6

XML Node

PendenciasFinanceirasDetalhe

Valor Total das Restrições

PendenciasFinanceirasDetalhe:

Item

Tipo

Nome

Descrição

6.6.1

Date

DataOcorrencia

Data da Ocorrência

6.6.2

varchar(30)

Modalidade

Modalidade do Titulo

6.6.3

varchar(1)

Avalista

Avalista do Titulo

6.6.4

varchar(3)

TipoMoeda

Tipo de Moeda Ex: R$

6.6.5

numeric(18,2)

Valor

Valor o Titulo

6.6.6

varchar(16)

Contrato

Numero do Contrato

6.6.7

varchar(30)

Origem

Origem do Titulo

6.6.8

varchar(4)

Sigla

Sigla da Origem do Titulo

6.6.9

varchar(1)

SubJudice

SubJudice (S/N)

6.6.10

varchar(80)

SubJudiceDescricao

Descricao de SubJudice

6.6.11

varchar(1)

TipoAnotacao

Tipo de Anotação

6.6.12

varchar(100)

TipoAnotacaoDescricao

Descrição do Tipo de Anotação

Obs: Este node pode se repetir várias vezes

PendenciasBacen:

Item

Tipo

Nome

Descrição

7.1

Integer

TotalOcorrencias

Quantidade de Restrições deste bloco

7.2

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições deste bloco

7.3

Date

OcorrenciaMaisAntiga

Data da Ocorrencia Mais Antiga (DD/MM/AAAA)

7.4

Date

OcorrenciaMaisRecente

Data da Ocorrencia Mais Recente (DD/MM/AAAA)

7.5

Numeric(18,2)

ValorTotalOcorrencias

Valor Total das Restrições

7.6

XML Node

PendenciasBacenDetalhe

Valor Total das Restrições

PendenciasBacenDetalhe:

Item

Tipo

Nome

Descrição

7.6.1

Date

DataOcorrencia

Data da Ocorrência

7.6.2

varchar(10)

NumeroCheque

Numero do Cheque

7.6.3

varchar(5)

AlineaCheque

Alinea de Devolução

7.6.4

varchar(5)

QuantidadeCCFBanco

Quantide Cheques Devolvidos

7.6.5

numeric(18,2)

Valor

Valor do Cheque

7.6.6

varchar(3)

Banco

Codigo do Banco

7.6.7

varchar(14)

NomeBanco

Nome do Banco

7.6.8

varchar(4)

Agencia

7.6.9

varchar(30)

Cidade

7.6.10

varchar(2)

Estado

Obs: Este node pode se repetir várias vezes

Participações Societárias:

Item

Tipo

Nome

Descrição

XML Node

Participacoes

Node contendo as participacoes societarias

8.1

XML Node

ParticipacaoSocietaria

Node contento os dados da participacao

8.2

varchar(8)

Pessoa

Tipo de Pessoa Fisica ou Juridica

8.3

varchar(14)

DocumentoEmpresa

CNPJ da Empresa em que participa

8.4

varchar(80)

Empresa

Razao Social da Empresa

8.5

numeric(18,2)

Percentual

Percentual de Participacao

8.6

varchar(2)

Estado

Unidade Federativa da Empresa

8.7

DateTime

DataUltimaAtualizacao

Data da ultima atualizacao no sistema

Obs: Este node só irá aparecer se for solicitado como Adicional e será cobrado além da consulta

Risk Score:

Item

Tipo

Nome

Descrição

XML Node

RiskScore

Node contendo a Analise de Risco

9.1

XML Node

PessoaFisica

Tipo de Pessoa

9.2

varchar(4)

Modelo

Tipo de modelo estatistico utilizado

9.3

varchar(1)

Calculado

Flag se foi calculado, S/N, Dados insuficientes quando não calculado

9.4

varchar(3)

Classe

Classificacao do Risco

9.5

numeric(18)

PercentualInadimplentes

Percentual de inadimplentes nesta classificacao

9.6

varchar(200)

Descricao

Descricao da Classificacao

Obs: Este node só irá aparecer se for solicitado como Adicional e será cobrado além da consulta

Limite de Crédito:

Item

Tipo

Nome

Descrição

XML Node

LimiteCredito

Node contendo Limite de Credito

10.1

XML Node

PessoaFisica

Tipo de Pessoa

10.2

varchar(4)

Valor

Valor sugerido para credito

10.3

XML Node

Observacoes

Observações sobre o limite de credito

10.4

varchar(100)

Item

Descrições, este node pode retornar mais de uma vez

Obs: Este node só irá aparecer se for solicitado como Adicional e será cobrado além da consulta

Transacao:

Item

Tipo

Nome

Descrição

XML Node

Transacao

Node contendo mensagem padronizada sobre a transação.

11.1

varchar(2)

Status

Status da Transação

11.2

varchar(2)

CodigoStatus

Código de Status

11.3

varchar(2)

CodigoStatusDescricao

Descrição do Codigo de Status

Atenção(*):

Todas as transações estão vindo agora com o Node XML <Transacao>, este node tem como finalidade padronizar as respostas de status e descrições. Quando estiver integrando suas aplicações nao utilizar as tags <Status> e <Descricao> porque elas serão descontinuadas em breve.

As mensagens de status novas estão documentadas no link abaixo: http://www.soawebservices.com.br/integracao/manuais/mensagens.aspx