PyXtSoaWebservice 0.0.6

PyXtSoaWebservice é uma biblioteca de acesso a API da Serasa, utilizando o distribuidor autorizado SOA Webservices

README

Esse README documenta o aplicativo pyXtSoawebservice com as etapas necessárias para colocar a comunicação com o Serasa Experian, utilizando o distribuidor autorizado SOA Webservices (i-Stream Comércio e Serviços Online Ltda).

Version

• Versão desta documentação: 1.0.0 (Jan/2020)

How do I get set up?

• Como faço para instalar:

  1. Instale os pacotes requeridos

     pip3 install -r requirements.txt

  2. Instale o pacote:

  python3 setup.py build python3 setup.py install

Funções e Procedimentos

• Consultas Administrativas de Parceiro - consultas dos seus dados de parceiro.

Funções Administrativas	Parâmetros	Descrição
ConsultStatus	eMail	string seu e-mail cadastrado noSerasa
* Consulta Status dos Serviços no webservice Serasa	Password	string sua senha cadastrado no Serasa
	Return	Retorna dicionário de resposta padrão***
ConsultBalance	eMail	string seu e-mail cadastrado no Serasa
* Consulta Saldo de sua Conta junto ao Serasa	Password	string sua senha cadastrado no Serasa
	Return	Retorna dicionário de resposta padrão***
ConsultBalance	eMail	string seu e-mail cadastrado no Serasa
* Consulta Extrato de sua conta junto ao Serasa	Password	string sua senha cadastrado no Serasa
	Month	Mês de verificação (2 digitos - 00)
	Year	Ano de verificação (4 digitos - 0000)
	Return	Retorna dicionário de resposta padrão***
ConsultExtractAnaliticDocument	eMail	string seu e-mail cadastrado no Serasa
* Consulta Historico Analitico de sua Conta junto ao Serasa	Password	string sua senha cadastrado no Serasa
Atenção	Documento	Número do CNPJ ***
Clientes com grande volume de transações não utilizar esta transação	Return	Retorna dicionário de resposta padrão***
ConsultHistoryDetailed	eMail	string seu e-mail cadastrado no Serasa
* Consulta o Histórico por documento dos serviços utilizados	Password	string sua senha cadastrado no Serasa
	IdDocumento	ID do documento
	Return	Retorna dicionário de resposta padrão***
ConsultCEP	Ambiente	string producao/homologacao
* Consulta CEP, retornando o endereço	eMail	string seu e-mail cadastrado no Serasa
	Password	string sua senha cadastrado no Serasa
	NumeroCEP	Código do CEP (somente número ex. 00000000)
	Return	Retorna dicionário de resposta padrão***

Funções Administrativas	Parâmetros	Descrição
ConsultCheque	eMail	string seu e-mail cadastrado no Serasa
* Consulta se os cheques constantes no lote, possui alguma restrição como roubo ou cancelamento.	Password	string sua senha cadastrado no Serasa
	Document	string número do CPF/CNPJ do titular do cheque
	CdBank	string Código Bacen da Instituíção que emitiu o cheque
	NrAgency	string Número da agência da Instituíção que emitiu o cheque
	NrAccount	string Número da conta do titular junto a instituíção que emitiu o cheque
	NrCheckIn	string Número inicial do lote do cheque
	NrCheckFim	string Número final do lote do cheque
	Environment	string/opcional producao/homologacao
	Return	Retorna dicionário de resposta padrão***
ConsultConcentre	eMail	string seu e-mail cadastrado no Serasa
* Esta transacao so verifica pendencias financeiras	Password	string sua senha cadastrado no Serasa
	Document	string número do CPF/CNPJ do consultado
	Additional	list Lista de adicionais pedido
		[ADD_NENHUM, ADD_QSOCIOS, ADD_PARTICIPA, ADD_RSCORING, ADD_LCREDIT, ADD_CLRISCO, ADD_LIST]
	Environment	string/opcional producao/homologacao
	Return	Retorna dicionário de resposta padrão***

Funções de Consultas Fiscais	Parâmetros	Retorno
ConsultFisicalCDCSimple	eMail	string seu e-mail cadastrado no Serasa
* Consulta se os cheques constantes no lote, possui alguma restrição como roubo ou cancelamento.	Password	string sua senha cadastrado no Serasa
	Document	string número do CPF/CNPJ do titular do cheque
	CdBank	string Código Bacen da Instituíção que emitiu o cheque
	NrAgency	string Número da agência da Instituíção que emitiu o cheque
	NrAccount	string Número da conta do titular junto a instituíção que emitiu o cheque
	NrCheckIn	string Número inicial do lote do cheque
	NrCheckFim	string Número final do lote do cheque
	Environment	string/opcional producao/homologacao
	Return	Retorna dicionário de resposta padrão***