
JDDDA
Layout de Integração Sistemas Legados
Mecanismo: Webservice
(Versão 2.0.17 em construção)
Histórico de Revisões
|
Data |
Versão |
Descrição |
Autor |
||||||||||||||||
|
16/02/09 |
1.0.0 |
Versão inicial |
DESIS |
||||||||||||||||
|
09/04/09 |
1.0.1 |
Adicionado NumCtrlIF, Situação na Inclusão do Sacado Eletrônico e Agregado. Adicionado campos de Data e Hora de inclusão e alteração. Novo método ConsultaSacadoConta Erros de digitação |
DESIS |
||||||||||||||||
|
24/04/09 |
1.0.2 |
Adicionado Nome do Sacado e Agregado. |
DESIS |
||||||||||||||||
|
24/04/09 |
1.0.3 |
Métodos de Consulta de Base. Padronização dos resultados XML |
DESIS |
||||||||||||||||
|
29/04/09 |
1.0.4 |
Adicionado Agência/Conta na inclusão do Título |
DESIS |
||||||||||||||||
|
30/04/09 |
1.0.5 |
Correção de Texto |
DESIS |
||||||||||||||||
|
05/05/09 |
1.0.6 |
Adicionado códigos de erro para o método Inclusão de Sacado Eletrônico: -375; -376. Adicionado códigos de erro para o método Inclusão de Agregado: -465; -466; -473. Retirado os métodos de Consulta de Base. Retirado Nome na inclusão,alteração e consulta do Sacado Eletrônico. Adicionado método Consulta Termo de Adesão Agregado. |
DESIS |
||||||||||||||||
|
06/05/09 |
1.0.7 |
|
DESIS |
||||||||||||||||
|
07/05/09 |
1.0.8 |
|
DESIS |
||||||||||||||||
|
13/05/09 |
2.0.1 |
|
DESIS |
||||||||||||||||
|
20/05/09 |
2.0.2 |
|
DESIS |
||||||||||||||||
|
21/05/09 |
2.0.3 |
|
DESIS |
||||||||||||||||
|
22/5/09 |
2.0.4 |
|
DESIS |
||||||||||||||||
|
25/5/09 |
2.0.5 |
- No método Incluir Agregado foi adicionado o tratamento de erro - 468 (CNPJ/CPF do agregado é o mesmo do Sacado Eletrônico informado). - No método Incluir Terceiro foi adicionado o tratamento de erro -518 (CNPJ ou CPF do Terceiro deve ser diferente do CNPJ ou CPF do Sac. Eletrônico). |
DESIS |
||||||||||||||||
|
02/06/09 |
2.0.7 |
|
DESIS |
||||||||||||||||
|
03/06/09 |
2.0.8 |
Exclusão de Sacado Eletrônico: Excluir
Consulta Sacado Eletrônico Próprio: ConsultarProprio
Inclusão de Agregado: Incluir
Exclusão de Agregado: Excluir
Consulta Agregado: Consultar
Consulta Lista dos Títulos do Sacado Eletrônico: ConsultarLista
Consulta Lote dos Títulos do Sacado Eletrônico: ConsultarLote
Detalhe de um Título do Sacado Eletrônico: Detalhar
Atualizar Situação de um Título do Sacado Eletrônico: AtualizarSituacao
Detalhe da Versão de um Título do Sacado Eletrônico: DetalharVersao
Incluido o item Descrição das tabelas que compõem a base integradora
Incluída a view VWJDDDACED_SITUACAO_TITULO que disponibiliza a situação do títulos no JDDDA emitidos pelo sistema legado da IF
Incluída a view VWJDDDASAC_TITULO_IF que disponibiliza a relação dos títulos recebidos da CIP para a própria instituição
Incluída a view VWJDDDASAC_TITULO_IF_NF que disponibiliza a relação das Notas Fiscais e os itens que à compõem dos títulos recebidos da CIP para a própria instituição.
|
DESIS |
||||||||||||||||
|
08/06 |
2.0.9 |
- No método Excluir foi adicionado o tratamento de erro – 318 (Agência e/ou Conta do Sacado Eletrônico não encontrada) - Nos métodos ConsultarSacadoConta e Excluir foi adicionado o tratamento de erro – 317 (Agência e/ou Conta não encontrada) - Nos métodos Aprovar e Rejeitar Sacado Eletronco, foram adicionados os tratamentos de erros –265 (Sacado Eletrônico já Aprovado) e –266 (Sacado Eletrônico já Rejeitado). - No método Incluir (Agregado) foi retirado o tratamento de erro –468 (CNPJ ou CPF do Agregado deve ser diferente do CNPJ ou CPF do Sac. Eletrônico) - Nos métodos Excluir (Agregado) e Consultar (Agregado). foram adicionado o tratamento do erro –447 (CNPJ/CPF do agregado é o mesmo do Sacado Eletrônico) - Nos métodos Consultar (Agregado), ConsultarLote e ConsultarLista foram adicionados o tratamento de erro -950 (Não existe resultado para informação solicitada.) . - No método ConsultarLote foi adicionado os tratamentos de erros
- No método ConsultarPróprio, foi alterada as descrições dos campos Agencia, TpConta e Conta. |
DESIS |
||||||||||||||||
|
22/06 |
2.0.10 |
- Nos métodos Aceitar Título e Rejeitar Título foram adicionado os tratamentos dos erros –712 (Título aguardando aceite na CIP) , –713 (Título aguardando rejeição na CIP) e –722 (Situação do Título não permite mais alterações) - Incluida a estrutura da tabela TBJDDDALEG_JD2LG_Erro |
DESIS |
||||||||||||||||
|
07/07 |
2.0.11 |
- Incluido o item Premissas em 2. Considerações Iniciais - Especificação do Layout do Arquivo CNAB Remessa e Retorno que será utilizado como uma das alternativas para troca de informações entre os Sistemas Legados e o JDDDA - Consulta Lista dos Títulos do Sacado Eletrônico: ConsultarLista
|
DESIS |
||||||||||||||||
|
27/07 |
2.0.12 |
- No item 4.5.2- Lay-out do Arquivo Remessa – Registro Transação – Tipo 1 foi incluida a observação sobre o dígito verificador do Código de Barras
- Alterado o nome do Anexo II de “Códigos de Erros” para “Códigos de Erros dos Webservices”
- Incluído o Anexo III – Códigos de Erros da Base Integradora
- Incluido o Anexo VI – Adaptação do Arquivo CNAB para utilização de dois períodos de desconto
- Alterada a descrição e tamanho do campo IdOperacaoLeg no mecanismo Base Integradora. Esta alteração objetiva ratificar que o valor deste campo deve ser úncio, independente do tipo de operação e do título.
- Adicionado os campos VlrLiqTitulo, DtLiqTitulo na tabela TBJDDDALEG_JD2LG_OPTITULO da Base Integradora. Estes campos serão preenchidos quando o Tipo de Baixa for 0 – Liquidação Interbancária e o COB615 for processado pelo JDDDA
- Adicionado o campo NmColuna na tabela TBJDDDALEG_JD2LG_ERRO da Base Integradora.
|
DESIS |
||||||||||||||||
|
14/08 |
2.0.13 |
|
DESIS |
||||||||||||||||
|
01/09 |
2.0.14 |
- Alteração da Descrição do Erro –640 De: Situação do Título fora de domínio, Para: Situação do Título Ativo fora de domínio; - Tratamento do Erro –640, foi retirado dos Métodos ConsultarLista e ConsultarLote ; - Adicionamos o erro –641 (Situação do Título fora de domínio) no Método ConsultarLista e ConsultarLote |
DESIS |
||||||||||||||||
|
02/09 |
2.0.14 |
- Corrigimos o exemplos de utilização do WebService em Visual .Net. |
DESIS |
||||||||||||||||
|
03/09 |
2.0.14 |
Alterada a estrutura de algumas tabelas da Base Integradora, conforme descrito a seguir: - Retirado da tabela TBJDDDALEG_JD2LG_Ctrl a coluna ISPBIF e atualizado o IdOperacaoJD para Number(20) - Retirado da tabela TBJDDDALEG_JD2LG_Erro as colunas: ISPBIF e IdOperacaoLeg. Atualizado o IdOperacaoJD para Number(20) - Na tabela TBJDDDALEG_JD2LG_OpTitulo foi atualizado o campo IdOperacaoJD para Number(20) |
|
||||||||||||||||
|
11/09 |
2.0.15 |
Para evitar impacto no desenvolvimento da base integradora o campo ISPB foi retornado para a tabela TBJDDDALEG_JD2LG_Ctrl |
DESIS |
||||||||||||||||
|
08/12/09 |
2.0.16
|
Para facilitar a localização as alterações efetuadas no documento encontram-se em vermelho - Novos códigos de erro do arquivo de retorno CNAB
- Ajustes no layout do Arquivo Remessa CNAB, para adaptação da Lei, conforme detalhado a seguir: - Indicador da versão do layout (posição 392 do header); - Registro Tipo 2 torna-se obrigatório e com a seqüência igual a seqüência do reg. Tipo 1 mais um; - Data limite segundo desconto (reg. Tipo 1); - Valor segundo desconto (reg. Tipo 1); - Sacador avalista (reg. Tipo 1); - Cedente (reg. Tipo 2); - Cedente original (reg. Tipo 2) - Endereço cedente original (reg. Tipo 2); - Município cedente original (reg. Tipo 2); - CEP cedente original (reg. Tipo 2); - UF cedente original (reg. Tipo 2);
- Adicionado o método de consulta paginada de títulos do sacado
- Retirado o Webservice de títulos do cedente.
- Revisão dos Domínios da JD (anexo I).
- Revisão dos Códigos de Erros dos WebServices (anexo II).
|
DESIS |
||||||||||||||||
|
04/02/10 |
2.0.17 em construção
|
Alterações referentes ao novo catálogo SPB 3.01: Novo domínio CIP: TpIdentcSacdrAvalst
Nos métodos ListarTitulos, ConsultarLote, Detalhar e DetalharVersao do WebService JDDDA_TituloSacadoEletronico, os tags do resultado XML TpPessoaSacdrAvalst e CPFCNPJSacdrAvalst foram removidos; e os tags TpIdentcSacdrAvalst e IdentcSacdrAvalst foram inseridos.
Nos métodos ListarTitulos, ConsultarLote, Detalhar e DetalharVersao do WebService JDDDA_TituloSacadoEletronico, os tags LogradSacdEletrnc, CidSacdEletrnc, UFSacdEletrnc e CEPSacdEletrnc se tornaram opcionais.
|
DESIS
|
Sumário
3. Estrutura dos WebServices 11
3.1. Padrão de comunicação com o WebService 11
3.2. Segurança dos WebServices 11
3.3. Interface dos WebServices 12
3.4. Sacado Eletrônico - WebService: JDDDA_SacadoEletronico 13
3.4.2. Inclusão de Sacado Eletrônico: Incluir 14
3.4.3. Exclusão de Sacado Eletrônico: Excluir 15
3.4.4. Alteração Sacado Eletrônico: Alterar 16
3.4.5. Consulta Sacado Eletrônico Próprio: ConsultarProprio 17
3.4.6. Consulta Sacado Eletrônico por Agência/Conta: ConsultarSacadoConta 19
3.4.7. Verifica Sacado Eletrônico: Verificar 20
3.4.8. Verifica Sacado Eletrônico Lote: VerificarLote 21
3.4.9. Aprovação Sacado Eletrônico: Aprovar 22
3.4.10. Rejeição Sacado Eletrônico: Rejeitar 23
3.5. Agregado WebService: JDDDA_SacadoEletronicoAgregado 24
3.5.1. Inclusão de Agregado: Incluir 25
3.5.2. Exclusão de Agregado: Excluir 26
3.5.3. Consulta Agregado: Consultar 27
3.5.4. Aprovação de Agregado: Aprovar 28
3.5.5. Rejeição de Agregado: Rejeitar 29
3.6. Título do Sacado - WebService: JDDDA_TituloSacadoEletronico 30
3.6.2. Listar Títulos Resumidos do Sacado Eletrônico: ListarTitulosResumo 31
3.6.3. Paginar Lista de Títulos Resumidos do Sacado Eletrônico: PaginarListaTitulosResumo 33
3.6.4. Listar Títulos do Sacado Eletrônico: ListarTitulos 33
3.6.5. Paginar Lista de Títulos do Sacado Eletrônico: PaginarListaTitulos 36
3.6.6. Consulta Lista dos Títulos do Sacado Eletrônico: ConsultarLista 36
3.6.7. Consulta Lote dos Títulos do Sacado Eletrônico: ConsultarLote 40
3.6.8. Detalhe de um Título do Sacado Eletrônico: Detalhar 47
3.6.9. Aceitar um Título do Sacado: Aceitar 51
3.6.10. Rejeitar um Título do Sacado Eletrônico: Rejeitar 52
3.6.11. Incluir Terceiro a Consultar um Título Próprio do Sacado Eletrônico: IncluirTerceiro 53
3.6.12. Alterar Terceiro a Consultar um Título Próprio do Sacado Eletrônico: AlterarTerceiro 54
3.6.13. Excluir Terceiro a Consultar um Título Próprio do Sacado Eletrônico: ExcluirTerceiro 55
3.6.14. Atualizar Situação de um Título do Sacado Eletrônico: AtualizarSituacao 56
3.6.16. Detalhe da Versão de um Título do Sacado Eletrônico: DetalharVersao 58
3.7. Exemplos de utilização do WebService 61
3.9. Exemplos de chamadas SOAP/XML para o WebService 65
3.9.1. Inclusão de Sacado Eletrônico: Incluir 65
3.9.2. Alteração Sacado Eletrônico: Alterar 66
3.9.3. Exclusão de Sacado Eletrônico: Excluir 67
3.9.4. Inclusão de Agregado: Incluir 68
3.9.5. Exclusão de Agregado: Excluir 69
3.10. Arquitetura Tecnológica Prevista 70
Este documento apresenta o layout dos WebServices para integração dos sistemas legados com o sistema JDDDA.
O DDA (Débito Direto Autorizado) é um serviço prestado pela CIP, que possibilita aos bancos participantes disponibilizarem e consultarem eletronicamente os títulos de cobrança no DDA, sendo estes originários de cedentes clientes de qualquer banco participante, destinados a clientes que tenham se cadastrado como sacado eletrônico.
As informações dos títulos de Cobrança e do cadastro de Sacado Eletrônico poderão ser consultadas e atualizadas (inclusão, alteração e exclusão) pelos bancos através de trocas de arquivos ou mensagens com a CIP.
O ambiente gerado pelo novo sistema DDA, em desenvolvimento pela CIP, alterará profundamente o processo do negócio da cobrança bancária no Brasil.
Ao substituir os títulos em papel pelos títulos eletrônicos, inicialmente no processo de apresentação e, posteriormente, no processo de liquidação, o DDA abre um amplo espectro de oportunidades e desafios para os Bancos que operam no país.
O JDDDA (JD Débito Direto Autorizado) é um aplicativo desenvolvido pela JD Consultores que atende integralmente todos os requisitos para que os Bancos possam atuar de forma eficaz tanto como Bancos Cedentes quanto como Bancos Sacados Eletrônicos dentro do ambiente do novo sistema DDA.
As informações trocadas entre os Sistemas Legados e o JDDDA podem ser agrupadas em duas grandes categorias:
Ponta Sacado – Trata das informações referentes a clientes da Instituição cadastrados como Sacados Eletrônicos no DDA e seus respectivos títulos eletrônicos;
Ponta Cedente – Trata das informações de títulos emitidos por clientes Cedentes que deverão ser cadastrados como títulos eletrônicos desde que o Sacado seja um Sacado Eletrônico no DDA.
O JDDDA possui quatro mecanismos para integração com os sistemas legados:
Webservices – Recomendado para troca de pequenos volumes de informação sob demanda;
Arquivos – Recomendado para troca de grandes volumes de informação e em horários pre-agendados;
Views – Utilizadas pelo JDDDA para disponibilizar a consulta dos Sistemas Legados a grande volumes de informações registradas no JDDDA;
Base Integradora – Recomendado para troca de grandes volumes de informação;
O fluxo das informações entre os Sistemas Legados e o JDDDA depende das características de negócio e do funcionamento dos sistemas existentes em cada Instituição e será detalhado na reunião técnica durante a implantação do sistema.
Este documento especifica apenas os mecanismos que o JDDDA possui para integração com os demais sistemas.
Premissas:
O DDA somente aceita títulos de Cobrança Registrada;
O DDA somente aceita títulos onde o Sacado é um Sacado Eletrônico;
Boletos impressos previamente pelo Cliente Cedente:
No caso de Cobrança Própria, onde o boleto é impresso com os dados do Banco Cedente, se as duas primeiras premissas forem cumpridas, o boleto deve ser enviado ao JDDDA;
No caso de Cobrança Terceirizada, onde o boleto é impresso com os dados do Banco Correspondente, mesmo cumprindo as duas primeiras premissas, o boleto deve ser enviado ao Banco Correspondente
WebService é uma solução tecnológica capaz de integrar aplicações e componentes de negócios entre diferentes entidades, utilizando o protocolo TCP como meio, sem perda de segurança. As principais vantagens de utilizar WebService são: interoperabilidade entre as aplicações distintas e fisicamente distantes, portabilidade entre diferentes plataformas, facilidade de integração e suporte, redução de custos para transporte de dados e formato universal.
Para o projeto JDDDA, o WebService foi desenvolvido em plataforma Microsoft oferecendo integração por meio da tecnologia SOAP/XML.
Todas as mensagens trocadas com o serviço devem utilizar o padrão SOAP/XML na versão 1.2.
Para garantir o controle de acesso aos Webservices, foram utilizados os preceitos do padrão WS-Security, utilizando uma estratégia de comunicação não orientada a conexão. Dessa forma, o SoapHeader da aplicação consumidora do Webservice deverá informar as credenciais do usuário e senha. A cada chamada, estas credenciais são autenticadas. Fica a cargo da Instituição a utilização de ferramentas de diretivas de segurança para garantir uma comunicação segura, tais como, SSL, HTTPS, WSE, PKI.
Caso ocorra alguma falha de autenticação o método retornará um Fault Packet com o código de erro -99888 – Falha de autenticação.
Parâmetros para a autenticação no webservice
|
Tags |
Tipo |
Tam |
Obrg |
Descrição |
|
Usuario |
String |
10 |
Sim |
Login da Aplicação que irá consumir o WebService |
|
Senha |
String |
30 |
Sim |
Senha da Aplicação que irá consumir o WebService |
Para instituições que abdicarem da utilização do controle de Usuário no SoapHeader, será criado um usuário padrão “anonymous” sem senha.
Exemplo de chamada utilizando SoapHeader
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Header SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:JDDDA_SacadoEletronicoIntf">
<NS1:TAutenticacao xsi:type="NS1:TAutenticacao">
<Usuario xsi:type="xsd:string">userid</Usuario>
<Senha xsi:type="xsd:string">password</Senha>
</NS1:TAutenticacao>
</SOAP-ENV:Header>
<SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<NS2:ConsultarTermoAdesao xmlns:NS2="urn:JDDDA_SacadoEletronicoIntf-IJDDDA_SacadoEletronico">
<CdLegado xsi:type="xsd:string">LEG</CdLegado>
<ISPBIF xsi:type="xsd:int">4358798</ISPBIF>
</NS2:ConsultarTermoAdesao>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Exemplo de falha na autenticação (Fault Packet)
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultactor> JDDDA_SacadoEletronico.ConsultarTermoAdesao</faultactor>
<faultcode>SOAP-ENV:-99888</faultcode>
<faultstring>Falha de autenticação. Usuário e/ou senha inválidos.</faultstring>
<detail>
<NS1:ERemotableException xmlns:NS1="urn:InvokeRegistry" xsi:type="NS1:ERemotableException"/>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
As funcionalidades do negócio do JDDDA foram divididas em 4 (quatro) WebServices. Sendo eles:
Sacado Eletrônico;
Agregados de Sacado Eletrônico;
Títulos Eletrônicos de Cliente Sacado Eletrônico;
Métodos relacionados:
Consulta Termo de Adesão ou Cancelamento do Sacado Eletrônico ou do Agregado: ConsultarTermo
Inclusão de Sacado Eletrônico: Incluir
Exclusão de Sacado Eletrônico: Excluir
Alteração Sacado Eletrônico: Alterar
Consulta Sacado Eletrônico Próprio: ConsultarProprio
Consulta Sacado Eletrônico por Agência/Conta: ConsultarSacadoConta
Verifica Sacado Eletrônico: Verificar
Verifica Sacado Eletrônico Lote: VerificarLote
Aprovação Sacado Eletrônico: Aprovar
Rejeição Sacado Eletrônico: Rejeitar
Este método permite a consulta do texto do Termo de Adesão ou Cancelamento ao DDA do Sacado Eletrônico ou do Agregado, válido na data da consulta, na base do JDDDA.
|
Parâmetros |
Tipo |
Tam |
Obrg |
Descrição |
|
CdLegado |
String |
3 |
Sim |
Código do Sistema Legado de Origem da Solicitação |
|
ISPBIF |
Inteiro |
8 |
Sim |
Número de identificação da Instituição Financeira no Sistema de Pagamentos Brasileiro |
|
JDDDATpTermo |
String |
2 |
Sim |
Tipo do termo |