M
M
M
Manual do Desenvolvedor
anual do Desenvolvedor
anual do Desenvolvedor
anual do Desenvolvedor
Plataforma
Plataforma
Plataforma
Plataforma e
e
e----Banrisul
e
Banrisul
Banrisul
Banrisul
Versão 2.7
Versão 2.7
Versão 2.7
Versão 2.7
SUMÁRIO SUMÁRIO SUMÁRIO SUMÁRIO 1. 1. 1.
1. INTRODUÇÃOINTRODUÇÃOINTRODUÇÃOINTRODUÇÃO ... 3...333
1.1 OBJETIVO ... 3 1.2 PÚBLICO-ALVO ... 3 1.3 ETAPAS ... 3 1.4 SUPORTE ... 3 2. 2. 2. 2. PRODUTOPRODUTOPRODUTOPRODUTO ... 4...444 2.1 MODALIDADES DE PAGAMENTOS ... 4
2.2 FORMAS DE AUTENTICAÇÃO ... 4
3. 3. 3. 3. VISÃOVISÃOVISÃO GERALVISÃOGERALGERAL ...GERAL... 6666 4. 4. 4. 4. LOJA B@NRISTORELOJA B@NRISTORELOJA B@NRISTORELOJA B@NRISTORE ... 7..777 5. 5. 5. 5. INTEGRAÇÃOINTEGRAÇÃOINTEGRAÇÃOINTEGRAÇÃO ... 7777 5.1 PAGAMENTO À VISTA (PGTA) ... 8
5.2 PAGAMENTO PRÉ-DATADO (PGTP) ... 9
5.2.1 Restrições: ... 10
5.3 PAGAMENTO PARCELADO (PGTX)... 10
5.3.1 Restrições: ... 11
5.4 PARA EMISSÃO DO BOLETO BANCÁRIO (PGBC) ... 12
5.5 CONFIRMAÇÃO DAS OPERAÇÕES ... 13
5.5.1 Fluxo/processo da operação: ... 14
5.5.2 Consulta pedido ... 15
5.5.3 Função de consulta pedidos ... 15
5.5.4 Transferência de dados via Internet ... 15
5.5.5 Retorno da consulta tipo X (XML) ... 17
5.5.6 Padrão do XML de comunicação Banrisul ... 19
5.5.7 Confirmação para pagamento por boleto bancário ... 21
6. 6. 6. 6. HOMOLOGAÇÃOHOMOLOGAÇÃOHOMOLOGAÇÃOHOMOLOGAÇÃO... 22....222222 6.1 MÓDULO DE CADASTRO DA PLATAFORMA BANRISUL ... 22
6.1.1 Mensagem do boleto bancário ... 23
6.1.2 Alteração de senha ... 23
6.2 MÓDULO DE PROCEDIMENTOS PARA HOMOLOGAÇÃO DA PLATAFORMA BANRISUL ... 23
6.3 REALIZAÇÃO DE TESTES PELA LOJA VIRTUAL ... 24
1. 1. 1.
1. INTRODUÇÃOINTRODUÇÃOINTRODUÇÃOINTRODUÇÃO
Seja bem-vindo ao Manual do DesenvolvedorManual do DesenvolvedorManual do DesenvolvedorManual do Desenvolvedor da plataforma e-commerce BanrisulBanrisulBanrisul. Banrisul
1.1 1.1 1.1
1.1 ObjetivoObjetivoObjetivoObjetivo
Esse manual tem por objetivo descrever as informações necessárias para realizar com sucesso a integração da sua loja virtual com o Banrisul, permitindo o recebimento de transações de débito dos clientes portadores do cartão Banricompras. Serão abordados os conceitos do produto e os temas técnicos que visam facilitar o entendimento e o desenvolvimento da solução de e-commerce.
1.2 1.2 1.2
1.2 PúblicoPúblicoPúblicoPúblico----alvoalvoalvoalvo
As informações deste manual são destinadas aos desenvolvedores de software, analistas e programadores de empresas parceiras da rede de adquirência Banrisul Vero.
1.3 1.3 1.3
1.3 EtapasEtapasEtapasEtapas
Ao todo, o processo de desenvolvimento da solução consiste basicamente em quatro etapas:
A equipe de suporte técnico, do Banrisul, estará à disposição para auxiliar na integração das soluções após o credenciamento do cliente (loja virtual) estar encaminhado com a área comercial da rede Vero.
1.4 1.4 1.4
1.4 Suporte Suporte Suporte Suporte
Durante o desenvolvimento e homologação, o Banrisul disponibiliza o seu suporte técnico, em horário comercial, através dos seguintes contatos:
Comercial ComercialComercial Comercial ---- 51 3215 2914 banrisul_cartoes_estrategia@banrisul.com.br Produtos ProdutosProdutos Produtos ---- 51 3215 1184 banrisul_cartoes_produtos@banrisul.com.br Homologação Homologação Homologação Homologação ---- 51 3215 3624 srac@banrisul.com.br 2. 2. 2.
2. PRODUTOPRODUTOPRODUTOPRODUTO
2.1 2.1 2.1
2.1 Modalidades de PagamentosModalidades de PagamentosModalidades de PagamentosModalidades de Pagamentos
A Banrisul Vero disponibiliza através da plataforma Banrisul as seguintes modalidades de pagamentos:
Banricompras à vista;
Banricompras pré-datado (até 60 dias); Banricompras parcelado (até 12x); Boleto Bancário Banrisul.
A empresa parceira poderá optar por oferecer aquelas modalidades que melhor atender as suas necessidades de negócio.
2.2 2.2 2.2
2.2 Formas de AutenticaçãoFormas de AutenticaçãoFormas de AutenticaçãoFormas de Autenticação
Quando o cliente escolher uma das modalidades de pagamentos acima descritas, o fluxo da navegação é desviado para um ambiente com conexão segura
conexão segura conexão segura
conexão segura (SSL) no site da plataforma Banrisul. Portanto, todas as informações trafegam em rede criptografada, desta forma protegendo o cliente final para fazer sua transação sem se preocupar com a segurança de seus dados.
Existem três formas de autenticaçãotrês formas de autenticaçãotrês formas de autenticação para viabilizar o pagamento do três formas de autenticação cliente Banrisul portador do cartão Banricompras:
FORMAS DE AUTENTICAÇÃO DA PLATAFORMA BANRISULFORMAS DE AUTENTICAÇÃO DA PLATAFORMA BANRISULFORMAS DE AUTENTICAÇÃO DA PLATAFORMA BANRISUL FORMAS DE AUTENTICAÇÃO DA PLATAFORMA BANRISUL
1. Autorização via tecnologia push notification com o aplicativo
Banrisul Digital habilitado para o portador cliente Banrisul. Aceita todas as modalidades (à vista, pré-datado e parcelado);
2. Digitação de token digitado Banricompras Vero Pay. Utilizado por clientes portadores ou compartilhado com terceiros. Aceita somente pagamentos à vista;
3. Pagamento com cartão físico Banricompras e leitora smart card
acoplada a um computador ou notebook. Aceita todas as modalidades (à vista, pré-datado e parcelado).
3. 3. 3.
3. VISÃOVISÃOVISÃOVISÃO GEGEGEGERALRALRALRAL
Início do processo Loja virtual credenciada Plataforma Banrisul Compra efetuada Consulta da transação Fim Transação autorizada + comprovante de pagamento do cliente Transação não autorizada NÃO SIM
4. 4. 4.
4. LOJA B@NRISTORELOJA B@NRISTORELOJA B@NRISTORELOJA B@NRISTORE
Para auxiliar no processo de integração, disponibilizamos uma loja loja loja loja virtual simplificada
virtual simplificada virtual simplificada
virtual simplificada para a realização de testes. A loja de demonstração está
disponível através do link da B@NRISTORE.
5. 5. 5.
5. INTEGRAÇÃOINTEGRAÇÃOINTEGRAÇÃOINTEGRAÇÃO
Concluídas todas as escolhas do cliente, para compra de seus produtos ou escolha de serviços na loja virtual, o cliente opta por uma das formas de pagamento. Neste momento, o fluxo da navegação é desviado para o endereço:
https://ww4.banrisul.com.br/banricompras/link/asp/ambiente.asp
Passando uma sequência de parâmetros, a formatação destes parâmetros é inerente de acordo com o tipo de pagamento selecionado. Estes parâmetros podem ser enviados por GetGetGetGet ou PostPostPost. Post
O desvio do fluxo de navegação deve ser feito pelo objeto windowwindowwindowwindow,
método openopenopenopen, conforme exemplo:
Veja a seguir a sequência de parâmetros para cada tipo de pagamento:
5.1 5.1 5.1
5.1 Pagamento à vista (PGTA)Pagamento à vista (PGTA)Pagamento à vista (PGTA)Pagamento à vista (PGTA)
CAMPO DESCRIÇÂO TAMANHO MÁXIMO (em bytes) FORMATO EXEMPLO
IdentPedido Identificação do Pedido 40 Alfanumérico 1010abc187
CodRede
Código da rede
(Fornecido pelo BANRISUL)
11 Numérico 123456
CodEstab
Código do estabelecimento
(Fornecido pelo BANRISUL)
15 Numérico 123456
VlrTotal Valor total da compra 15 Numérico
Para R$22,50 (vinte dois reais e cinquenta centavos): 000000000002250
FormaPagto Forma de Pagamento 04 Alfanumérico PGTA
Exemplo de parâmetros para uma compra com pagamento à vista no valor de R$ 39,95 pelo método ‘GET’:
?identPedido=531123&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=531123&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=531123&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=531123&CodRede=00281120002&CodEstab=0041000000000 01&VlrTotal=000000000003995&FormaPagto=PGTA 01&VlrTotal=000000000003995&FormaPagto=PGTA 01&VlrTotal=000000000003995&FormaPagto=PGTA 01&VlrTotal=000000000003995&FormaPagto=PGTA <SCRIPT LANGUAGE=JavaScript> function Submeter (Url) {
window.open(Url, "Demonstrativo", Opcoes, true); }
</SCRIPT>
<A href=”Pagina.htm” OnMouseDown =
Submeter("https://ww4.banrisul.com.br/banricompras/link/asp/ambiente.asp?ident pedido=12345&CodRede=123456&CodEstab=0066&VlrTotal=000000000001000&FormaPagto =PGTA")>Á Vista</A>
5.2 5.2 5.2
5.2 Pagamento préPagamento préPagamento préPagamento pré----datado (PGTP)datado (PGTP)datado (PGTP) datado (PGTP)
CAMPO DESCRIÇÃO
TAMANHO MÁXIMO (em bytes)
FORMATO EXEMPLO
IdentPedido Identificação do Pedido 40 Alfanumérico 1010abc187
CodRede
Código da rede
(Fornecido pelo BANRISUL)
11 Numérico 123456
CodEstab
Código do estabelecimento
(Fornecido pelo BANRISUL)
15 Numérico 123456
VlrTotal Valor total da compra 15 Numérico
Para R$22,50 (vinte dois reais e cinquenta centavos):
000000000002250
FormaPagto Forma de Pagamento 04 Alfanumérico PGTP
NumParcelas Número de parcelas 02 Numérico 01
Opção Data ou prazo para
pagamento 01 Alfanumérico
Data:
D
Prazo: P
Parcela Número da parcela 02 Numérico 01
DataSugerida Data escolhida pelo cliente 08 Data
Se campo Opcao = D, DataSugerida = AAAAMMDD; Se campo Opcao = P, DataSugerida = 00000000
Prazo Prazo em dias escolhido
pelo cliente 03 Numérico
Se campo Opcao = D, Prazo = 000;
Se campo Opcao = P, Prazo = 015(ex.: 15 dias)
VlrParcela Valor da Parcela 15 Numérico
Para R$22,50 (vinte dois reais e cinquenta centavos), informar: 000000000002250
Exemplo de parâmetros para uma compra com pagamento pré-datado no valor de R$ 7,99 com prazo de 20 dias pelo método ‘GET’:
?identPedido=221342&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=221342&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=221342&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=221342&CodRede=00281120002&CodEstab=0000002811200 01&VlrTotal=000000000000799&FormaPagto=PGTP&NumParce 01&VlrTotal=000000000000799&FormaPagto=PGTP&NumParce 01&VlrTotal=000000000000799&FormaPagto=PGTP&NumParce
01&VlrTotal=000000000000799&FormaPagto=PGTP&NumParcelas=01&Opclas=01&Opclas=01&Opclas=01&Opc ao=P&Parcela=01&DataSugerida=00000000&Prazo=20&VlrParcela=0000000 ao=P&Parcela=01&DataSugerida=00000000&Prazo=20&VlrParcela=0000000 ao=P&Parcela=01&DataSugerida=00000000&Prazo=20&VlrParcela=0000000 ao=P&Parcela=01&DataSugerida=00000000&Prazo=20&VlrParcela=0000000 00000799 00000799 00000799 00000799
Exemplo de parâmetros para uma compra com pagamento pré-datado no valor de R$ 39,95 com data para pagamento em 30/12/2002 pelo método ‘GET’:
?identPedido=221343&CodRed ?identPedido=221343&CodRed ?identPedido=221343&CodRed
?identPedido=221343&CodRede=00281120002&CodEstab=0000002811200e=00281120002&CodEstab=0000002811200e=00281120002&CodEstab=0000002811200e=00281120002&CodEstab=0000002811200 01&VlrTotal=000000000003995&FormaPagto=PGTP&NumParcelas=01&Opc 01&VlrTotal=000000000003995&FormaPagto=PGTP&NumParcelas=01&Opc 01&VlrTotal=000000000003995&FormaPagto=PGTP&NumParcelas=01&Opc 01&VlrTotal=000000000003995&FormaPagto=PGTP&NumParcelas=01&Opc ao=D&Parcela=01&DataSugerida=20021230&Prazo=0&VlrParcela=0000000 ao=D&Parcela=01&DataSugerida=20021230&Prazo=0&VlrParcela=0000000 ao=D&Parcela=01&DataSugerida=20021230&Prazo=0&VlrParcela=0000000 ao=D&Parcela=01&DataSugerida=20021230&Prazo=0&VlrParcela=0000000 00003995 00003995 00003995 00003995 5.2.1 5.2.1 5.2.1
5.2.1 Restrições:Restrições: Restrições:Restrições:
o O prazo máximo não pode ultrapassar 60 dias60 dias60 dias; 60 dias
o O número de parcelas deve ser sempre 00010111. 5.3
5.3 5.3
5.3 Pagamento parcelado (PGTX)Pagamento parcelado (PGTX)Pagamento parcelado (PGTX)Pagamento parcelado (PGTX)
CAMPO DESCRIÇÃO
TAMANHO MÁXIMO (em bytes)
FORMATO EXEMPLO
IdentPedido Identificação do Pedido 40 Alfanumérico 1010abc187
CodRede Código da rede (Fornecido pelo BANRISUL) 11 Numérico 123456 CodEstab Código do estabelecimento (Fornecido pelo BANRISUL) 15 Numérico 123456
VlrTotal Valor total da compra 15 Numérico
Para R$22,50 (vinte dois reais e cinquenta centavos):
000000000002250
FormaPagto Forma de Pagamento 04 Alfanumérico PGTX
NumParcelas
Número de parcelas
Máximo de 25 parcelas
02 Numérico Para 6 (seis) parcelas: 06
Opcao Data ou prazo para
pagamento 01 Alfanumérico
Data:D
Parcela
Número da parcela
até 25 ocorrências
02 Numérico Para pagamento em duas parcelas: 0102
DataSugerida
Data escolhida pelo cliente
até 25 ocorrências 08 Data Somente se campo Opcao = D, DataSugerida = AAAAMMDD; Prazo
Prazo escolhido pelo cliente
até 25 ocorrências 03 Numérico Somente se campo Opcao = P, Prazo = 015 (ex.: 15 dias) VlrParcela Valor da Parcela até 25 ocorrências 15 Numérico
Para duas parcelas de R$22,50 (vinte dois reais e cinquenta centavos), informar: 000000000002250
Exemplo de parâmetros para uma compra com pagamento parcelado no valor de R$ 31,92 em 02 parcelas, sendo a primeira parcela à vista (20/12/2002) pelo método ‘Post’:
?identPedido=351346&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=351346&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=351346&CodRede=00281120002&CodEstab=0041000000000 ?identPedido=351346&CodRede=00281120002&CodEstab=0041000000000 01&VlrTotal=000000000003192&FormaPagto=PGTX&NumParcelas=02&Opc 01&VlrTotal=000000000003192&FormaPagto=PGTX&NumParcelas=02&Opc 01&VlrTotal=000000000003192&FormaPagto=PGTX&NumParcelas=02&Opc 01&VlrTotal=000000000003192&FormaPagto=PGTX&NumParcelas=02&Opc ao=P&Parcela=0102&DataSugerida=2002122020030119&Prazo=000030&Vl ao=P&Parcela=0102&DataSugerida=2002122020030119&Prazo=000030&Vl ao=P&Parcela=0102&DataSugerida=2002122020030119&Prazo=000030&Vl ao=P&Parcela=0102&DataSugerida=2002122020030119&Prazo=000030&Vl rParcela= 00000000000159600000000000159 rParcela= 00000000000159600000000000159 rParcela= 00000000000159600000000000159 rParcela= 00000000000159600000000000159666 6
Exemplo de parâmetros para uma compra com pagamento parcelado no valor de R$ 33,83 em 02 parcelas, sendo a primeira parcela para 30 dias pelo método ‘Post’:
?identPedido=23147&CodRede=00281120002&CodEstab=00000028112000 ?identPedido=23147&CodRede=00281120002&CodEstab=00000028112000 ?identPedido=23147&CodRede=00281120002&CodEstab=00000028112000 ?identPedido=23147&CodRede=00281120002&CodEstab=00000028112000 1&VlrTotal=000000000003383&For 1&VlrTotal=000000000003383&For 1&VlrTotal=000000000003383&For
1&VlrTotal=000000000003383&FormaPagto=PGTX&NumParcelas=02&OpcamaPagto=PGTX&NumParcelas=02&OpcamaPagto=PGTX&NumParcelas=02&OpcamaPagto=PGTX&NumParcelas=02&Opca o=P&Parcela=0102&DataSugerida=2003011920030218&Prazo=030060&Vlr o=P&Parcela=0102&DataSugerida=2003011920030218&Prazo=030060&Vlr o=P&Parcela=0102&DataSugerida=2003011920030218&Prazo=030060&Vlr o=P&Parcela=0102&DataSugerida=2003011920030218&Prazo=030060&Vlr Parcela=000000000001691000000000001692 Parcela=000000000001691000000000001692 Parcela=000000000001691000000000001692 Parcela=000000000001691000000000001692 5.3.1 5.3.1 5.3.1
5.3.1 Restrições:Restrições: Restrições:Restrições:
o Primeira parcela pode ser programada para qualquer data, sendo
que a última parcela deve respeitar o prazo máximo (366 dias366 dias366 dias); 366 dias
o Última parcela não pode ultrapassar 366 dias366 dias366 dias366 dias;
5.4 5.4 5.4
5.4 Para emissão do boleto bancário (PGBC)Para emissão do boleto bancário (PGBC)Para emissão do boleto bancário (PGBC)Para emissão do boleto bancário (PGBC)
CAMPO DESCRIÇÃO
TAMANHO MÁXIMO (em bytes)
FORMATO EXEMPLO
IdentPedido Identificação do Pedido 40 Alfanumérico 1010abc187
CodRede
Código da rede
(Fornecido pelo BANRISUL)
11 Numérico 123456
CodEstab
Código do estabelecimento
(Fornecido pelo BANRISUL)
15 Numérico 123456
Vcto Data do Vencimento 08 Numérico
A vista:
00000000
Data do Vencimento:
20012003 (DDMMAAAA)
VlrTotal Valor total da compra 10 Numérico
Para R$22,50 (vinte dois reais e cinquenta centavos):
0000002250
FormaPagto Forma de Pagamento 04 Alfanumérico PGBC
Sacado Nome do Sacado 30 Alfanumérico Jose Roberto Pedro
End1 Tipo do Logradouro + Logradouro + Número do Endereço + Complemento 40 Alfanumérico Rua, dos Andradas, 1500. AP.15-A
Uf Unidade Federativa 02 Alfanumérico RS
Cidade Cidade 25 Alfanumérico Porto Alegre
Cep Código de endereçamento
postal 09 Alfanumérico 90018-900
Exemplo de parâmetros para uma compra com pagamento via boleto bancário, vencimento data atual e valor R$ 63,92:
?identPedido=551430&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=551430&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=551430&CodRede=00281120002&CodEstab=0000002811200 ?identPedido=551430&CodRede=00281120002&CodEstab=0000002811200 01&Vcto=00000000&VlrTotal=0000006392&FormaPagto=PGBC&Sacado=Jo 01&Vcto=00000000&VlrTotal=0000006392&FormaPagto=PGBC&Sacado=Jo 01&Vcto=00000000&VlrTotal=0000006392&FormaPagto=PGBC&Sacado=Jo 01&Vcto=00000000&VlrTotal=0000006392&FormaPagto=PGBC&Sacado=Jo se%20Roberto%20Pedro&End1=RUA%20dos% se%20Roberto%20Pedro&End1=RUA%20dos% se%20Roberto%20Pedro&End1=RUA%20dos%
se%20Roberto%20Pedro&End1=RUA%20dos%20Andradas%20N.%20500%220Andradas%20N.%20500%220Andradas%20N.%20500%220Andradas%20N.%20500%2 0%20AP.%2021
0%20AP.%2021 0%20AP.%2021
Obs.: No pagamento via Boleto Bancário, a empresa credenciada definirá a data de vencimento do documento.
5.5 5.5 5.5
5.5 ConfirmaçãoConfirmaçãoConfirmaçãoConfirmação das odas odas operaçdas operaçperaçperaçõesõesões ões
Nas compras com opção de pagamento à vista, pré-datado e parcelado, após o processamento da compra pelo Banrisul, o cliente recebe do sistema a confirmação da operação realizada. Trata-se de comprovante de pagamento gerado no ambiente Banricomprapontocom.
o O cliente recebe, pelo seu navegador, um comprovante de
pagamento autenticado;
o Utilizando os dados da confirmação, o credenciado acessa a
função de consulta do Banrisul obtendo informações detalhadas da operação.
5.5.1 5.5.1 5.5.1
5.5.1 FluxoFluxo////processo da operação:FluxoFluxo processo da operação:processo da operação: processo da operação:
C
li
e
n
te
L
o
ja
B
a
n
ri
s
u
l
1) Acessa Loja Virtual
5) Desvia para Banrisul com as informações da compra 2) Seleciona Produtos 3) Apresenta Formas de Pagamentos 4) Escolhe Forma de Pagamento 6) Solicita autenticação ao cliente
7) Cliente escolhe uma das formas de autenticação 10) Host autoriza e apresenta comprovante de pagamento 13) Consulta Operações 14) Resposta Consulta 8) Solicita dados de acordo com a forma escolhida de autenticação
9) Cliente informa os dados e autoriza pagamento
5.5.2 5.5.2 5.5.2
5.5.2 Consulta pedidoConsulta pedido Consulta pedidoConsulta pedido
A loja virtual deverá consultar os pedidos (transações) cujos pagamentos foram efetuados pela plataforma Banrisul, utilizando uma das seguintes transações:
o Função de consulta pedidos;
o Transferência de dados via Internet.
5.5.3 5.5.3 5.5.3
5.5.3 Função de consulta pedidosFunção de consulta pedidos Função de consulta pedidosFunção de consulta pedidos
Disponível através do endereço (URL):
https://ww4.banrisul.com.br/banricompras
PÁGINA PARA CONSULTA DE PEDIDOS PÁGINA PARA CONSULTA DE PEDIDOSPÁGINA PARA CONSULTA DE PEDIDOS PÁGINA PARA CONSULTA DE PEDIDOS
5.5.4 5.5.4 5.5.4
5.5.4 TransferêTransferência de dados via InternetTransferêTransferência de dados via Internetncia de dados via Internetncia de dados via Internet
Pelo método ‘GetGetGetGet’ ou ‘PostPostPost’. Para isto, basta acessar o endereço (URL) Post
abaixo e encaminhar os seguintes parâmetros:
CAMPO DESCRIÇÃO
TAMANHO MÁXIMO (em bytes)
FORMATO EXEMPLO
idE01 Rede (Fornecido
pelo BANRISUL) 11 Numérico 00000123456
idF01
Estabelecimento (Fornecido pelo BANRISUL)
15 Numérico 000000000123456
ioP01 Tipo 01 Alfanumérico
Pedido específico 1 Período
4
Caso pedido especifico:
idP01 Id.Pedido 40 Alfanumérico 1a2b3c456
Caso Período:
IdataInicial Data Inicial
14 Ou 08 AAAAMMDDhh mmss Ou AAAAMMDD 20060301203000 ou 20060301
IdataFinal Data Final
14 Ou 08 AAAAMMDDhh mmss Ou AAAAMMDD 20060301233000 ou 20060301
idT01 Resposta Consulta 01 Alfanumérico Layout tipo XML
X
idSenha01 Senha da Consulta 10 Alfanumérico
1234567890 “USAR APENAS LETRAS E NÚMEROS” – CASE SENSITIVE Observações:
1. Na consulta por Período, fica compreendido um período de no máximo 31 dias. 2. No parâmetro IdataInicial, quando omitida a representação de hora (hhmmss), será
considerado o valor 000000.
3. No parâmetro IdataFinal, quando omitida a representação de hora (hhmmss), será considerado o valor 235959.
4. No parâmetro IdSenha, poderá ter até no máximo 10 caracteres alfanumérico. 5. No parâmetro IdSenha, “usar apenas letras e números – case sensitive”.
Exemplo de parâmetros encaminhados para uma consulta por pedido específico igual a 1a2b3c4561a2b3c4561a2b3c4561a2b3c456 e idt01=X (XML).
?idE01=00281120002&idF01=000000281120001&IoP01=1&idp01=1a2b3c4 ?idE01=00281120002&idF01=000000281120001&IoP01=1&idp01=1a2b3c4 ?idE01=00281120002&idF01=000000281120001&IoP01=1&idp01=1a2b3c4 ?idE01=00281120002&idF01=000000281120001&IoP01=1&idp01=1a2b3c4 56&idt01=X&idSenha01=1234567890 56&idt01=X&idSenha01=1234567890 56&idt01=X&idSenha01=1234567890 56&idt01=X&idSenha01=1234567890
Exemplo de parâmetros encaminhados para uma consulta por período de 31 dias31 dias31 dias com Data Inicial igual a 01/03/200631 dias 01/03/200601/03/2006, Data Final 01/03/2006 31/03/2006 31/03/2006 31/03/2006 31/03/2006 e idt01=X (XML). ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 60301& IdataFinal=20060331&idt01=X&idSenha01=1234567890 60301& IdataFinal=20060331&idt01=X&idSenha01=1234567890 60301& IdataFinal=20060331&idt01=X&idSenha01=1234567890 60301& IdataFinal=20060331&idt01=X&idSenha01=1234567890
Exemplo de parâmetros encaminhados para uma consulta por um período de 3 horas3 horas3 horas3 horas atrás, a partir da Data Final da consulta: Data Inicial igual a 01/03/2006 às 20:30:0001/03/2006 às 20:30:0001/03/2006 às 20:30:00, Data Final 01/03/2006 às 23:30:0001/03/2006 às 20:30:00 01/03/2006 às 23:30:0001/03/2006 às 23:30:00 e 01/03/2006 às 23:30:00 idt01=X (XML). ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 ?idE01=00281120002&idF01=000000281120001&IoP01=4&IdataInicial=200 60301203000& 60301203000& 60301203000& 60301203000& IdataFinal=20060301233000&idt01=X&idSenha01=1234567890 IdataFinal=20060301233000&idt01=X&idSenha01=1234567890 IdataFinal=20060301233000&idt01=X&idSenha01=1234567890 IdataFinal=20060301233000&idt01=X&idSenha01=1234567890 5.5.5 5.5.5 5.5.5
5.5.5 Retorno da consulta tipo X (XML)Retorno da consulta tipo X (XML) Retorno da consulta tipo X (XML)Retorno da consulta tipo X (XML)
Como retorno desta consulta, a função devolve uma página com o seguinte layout: CAMPO DESCRIÇÃO TAMANHO MÁXIMO (em bytes) FORMATO EXEMPLO
dt_movimento Data da Operação 6 Date DD/MM/AAAA
nsu_origem Número sequencial único da operação no DB2
6 Numérico 006742
cod_rede Código da Rede 11 Numérico 12345678901
cod_estab Código do
Estabelecimento
15 Numérico 123456789012345
dt_hr_origem Datahora da operação
18 TimeStamp DD/MM/AAAAHH:MM: SS
num_parcelas Número de parcelas de acordo com a forma de pagamento escolhida
02 Numérico Operação parcelada em 12 vezes
12 parcelas
nsu_movimento Número sequencial único da operação no IBM
08 Numérico 00012511
valor_movimento Valor Total da operação
15 Numérico 25,00
mnemonico_servico Forma de pagamento
04 Alfanumérico PGTA
descricao Descrição da forma de pagamento
40 Alfanumérico BANRICOMPRAS À VISTA
situacao Status da Operação 14 Alfanumérico AUTORIZADO; NÃO
AUTORIZADO; EMITIDO; EM PROCESSAMENTO
O campo situacaosituacaosituacaosituacao indica o estado da operação. Informa se a transação foi concluída com sucesso (situação AUTORIZADAAUTORIZADAAUTORIZADAAUTORIZADA), ou se a transação foi cancelada ou não concluída (situação NÃO AUTORIZADANÃO AUTORIZADANÃO AUTORIZADANÃO AUTORIZADA). Indica ainda se o boleto foi processado corretamente (situação EMITIDOEMITIDOEMITIDO), ou se o cliente EMITIDO está em processo de compra no ambiente do Banrisul (situação EM EM EM EM PROCESSAMENTO
PROCESSAMENTO PROCESSAMENTO PROCESSAMENTO).
Com a execução desta consulta, a loja virtual pode “trabalhar” as informações do seu retorno para dar prosseguimento na entrega dos produtos, execução de serviços, atualização de suas bases de dados, e etc.
No exemplo 01 abaixo, segue a execução de uma consulta XML: <?xml version='1.0' encoding='ISO-8859-1' ?><xml><status codigoretorno="00" codigomensagem="" mensagem=""/> <metadados>
<registros>
<registro Nome="registrousuario"> <campos>
<campo nome="dt_movimento" tipo="date" tamanhomaximo="6" obrigatorio="1" chaveprimaria="0" /> <campo nome="nsu_origem" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="cod_rede" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="cod_estab" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="id_pedido" tipo="string" tamanhomaximo="40" obrigatorio="1" chaveprimaria="0" /> <campo nome="dt_hr_origem" tipo="dateTime" tamanhomaximo="16" obrigatorio="1" chaveprimaria="0" /> <campo nome="num_parcelas" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="nsu_movimento" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="valor_movimento" tipo="double" tamanhomaximo="19" obrigatorio="1" chaveprimaria="0" /> <campo nome="mnemonico_servico" tipo="string" tamanhomaximo="4" obrigatorio="1" chaveprimaria="0" /> <campo nome="descricao" tipo="string" tamanhomaximo="40" obrigatorio="1" chaveprimaria="0" /> <campo nome="situacao" tipo="string" tamanhomaximo="14" obrigatorio="1" chaveprimaria="0" /> </campos>
</registro> </registros>
</metadados> <dados>
<registrousuario dt_movimento="17/03/2006" nsu_origem="485" cod_rede="281120002" cod_estab="281120001" id_pedido="localhost_20060317_28 " dt_hr_origem="17/03/2006 11:10:32" num_parcelas=""
nsu_movimento="" valor_movimento="0.01" mnemonico_servico="PGTA" descricao="BANRICOMPRAS À VISTA " situacao="NÃO AUTORIZADO"/>
</dados> </xml> 5.5.6 5.5.6 5.5.6
5.5.6 Padrão do XML de comunicação BanrisulPadrão do XML de comunicação Banrisul Padrão do XML de comunicação BanrisulPadrão do XML de comunicação Banrisul
O funcionamento da comunicação entre camadas de interface é realizado via XML. O padrão abaixo é o documento que valida o XML:
<?xml version='1.0'?>
<xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='http://www.banrisul.com.br'
xmlns='http://www.banrisul.com.br' elementFormDefault='qualified'>
<xs:complexType name='tipoStatus'>
<xs:attribute name='codigoretorno' type='xs:string' default='00'/> <xs:attribute name='codigomensagem' type='xs:string' use='optional'/> <xs:attribute name='mensagem' type='xs:string' use='optional'/> </xs:complexType>
<xs:complexType name='tipoErro'>
<xs:attribute name='codigofalha' type='xs:string' use='optional'/> <xs:attribute name='descricao' type='xs:string' use='optional'/> <xs:attribute name='sistema' type='xs:string' use='optional'/> <xs:attribute name='modulo' type='xs:string' use='optional'/> <xs:attribute name='funcao' type='xs:string' use='optional'/> <xs:attribute name='comandosql' type='xs:string' use='optional'/>
<xs:attribute name='parametrosentrada' type='xs:string' use='optional'/> <xs:attribute name='pontoprograma' type='xs:string' use='optional'/> <xs:attribute name='retornocomunicacao' type='xs:string' use='optional'/> <xs:attribute name='retornousuario' type='xs:string' use='optional'/> </xs:complexType> <xs:simpleType name='tipoTiposDados'> <xs:restriction base="xs:string"> <xs:enumeration value="string"/> <xs:enumeration value="inteiro"/> <xs:enumeration value="binario"/> <xs:enumeration value="decimal"/> <xs:enumeration value="data"/> </xs:restriction> </xs:simpleType> <xs:complexType name='tipoCampo'>
<xs:attribute name='nome' type='xs:string' use='required'/> <xs:attribute name='tipo' type='tipoTiposDados'/>
<xs:attribute name='tamanhomaximo' type='xs:integer'/> <xs:attribute name='obrigatorio' type='xs:boolean'/> <xs:attribute name='chaveprimaria' type='xs:boolean'/> <xs:attribute name='chaveestrangeira' type='xs:string'/> </xs:complexType> <xs:complexType name='tipoRegistro'> <xs:sequence> <xs:element name='campos'> <xs:complexType> <xs:sequence>
<xs:element name='campo' minOccurs='1' maxOccurs='unbounded' type='tipoCampo'/>
</xs:sequence> </xs:complexType> </xs:element> </xs:sequence>
<xs:attribute name='nome' type='xs:string' use='required'/> </xs:complexType>
<xs:complexType name='tipoRegistros'> <xs:sequence>
<xs:element name='registro' minOccurs='1' maxOccurs='unbounded' type='tipoRegistro'/>
</xs:sequence> </xs:complexType>
<xs:complexType name='tipoMetaDados'> <xs:choice>
<xs:element name='registros' type='tipoRegistros'/> <xs:element name='relatorio' type='xs:string'/> </xs:choice>
</xs:complexType>
<xs:complexType name='tipoDados'> <xs:sequence>
<xs:any namespace='#local' processContents='skip'/> </xs:sequence>
</xs:complexType> <xs:element name='xml'> <xs:complexType> <xs:sequence>
<xs:element name='status' minOccurs='1' type='tipoStatus'/> <xs:element name='erro' minOccurs='0' type='tipoErro'/>
<xs:element name='metadados' minOccurs='0' type='tipoMetaDados'/> <xs:element name='dados' type='tipoDados'/>
</xs:sequence> </xs:complexType> </xs:element> </xs:schema> Exemplo 02: <?xml version="1.0" encoding="ISO-8859-1"?> <xml>
<status codigoretorno="00" codigomensagem="" mensagem=""/>
<erro codigoFalha="00000" descricao="" sistema="" modulo="" funcao="" comandosql="" parametrosentrada="" /> <metadados> <registros> <registro nome="Pessoa"> <campos>
<campo nome="IDPessoa" tipo="inteiro"
tamanhomaximo="6" obrigatorio="1"
chaveporimaria="1" />
<campo nome="Nome" tipo="string"
tamanhomaximo="30" obrigatorio="1" />
<campo nome="Telefone" tipo="string"
tamanhomaximo="20" obrigatorio="0" />
<campo nome="Idade" tipo="inteiro"
tamanhomaximo="3" obrigatorio="0" />
</campos>
</registro>
<registro nome="Filho">
<campos>
<campo nome="IDPessoa" tipo="inteiro"
tamanhomaximo="6" obrigatorio= "1"
chaveestrangeira="Pessoas.IDPessoa" />
<campo nome="IDFilho" tipo= "string"
tamanhomaximo="30" obrigatorio="1" />
<campo nome="Nome" tipo="string"
tamanhomaximo="30" obrigatorio="1" /> </campos> </registro> </registros> </metadados> <dados>
<pessoa IDPessoa= "2" Nome= "Beltrano" Idade="32" />
<filho IDPessoa="1" IDFilho= "1" Nome= "Filho do Fulano"/> </dados> </xml> 5.5.7 5.5.7 5.5.7
5.5.7 Confirmação para pagamento por boleto bancárioConfirmação para pagamento por boleto bancário Confirmação para pagamento por boleto bancárioConfirmação para pagamento por boleto bancário
Nas compras com opção de pagamento por boleto bancário, o Banrisul desvia o fluxo de navegação para a página que confirma a efetivação da operação na loja virtual, e em uma nova janela, exibe a página de emissão do boleto bancário.
Loja Virtual Banricompras. com Página Confirmação de compra da Loja Virtual Início Fim Boleto Bancário
CONFIRMAÇÃO DE COMPRA FEITA POR BOLETO BANCÁRIO CONFIRMAÇÃO DE COMPRA FEITA POR BOLETO BANCÁRIOCONFIRMAÇÃO DE COMPRA FEITA POR BOLETO BANCÁRIO
CONFIRMAÇÃO DE COMPRA FEITA POR BOLETO BANCÁRIO (B@NRISTORE)(B@NRISTORE)(B@NRISTORE)(B@NRISTORE)
6. 6. 6.
6. HOMOLOGAÇÃOHOMOLOGAÇÃOHOMOLOGAÇÃOHOMOLOGAÇÃO 6.1
6.1 6.1
6.1 Módulo de cadastro dMódulo de cadastro dMódulo de cadastro dMódulo de cadastro da plataforma Banrisula plataforma Banrisula plataforma Banrisula plataforma Banrisul
Na página inicial do módulo de cadastro é solicitado o código da rede, o código do estabelecimento e a senha de acesso. O cadastramento desta O cadastramento desta O cadastramento desta O cadastramento desta senha de acesso será solicitado
senha de acesso será solicitado senha de acesso será solicitado
senha de acesso será solicitado nonono primeiro acesso do desenvolvedor a este noprimeiro acesso do desenvolvedor a este primeiro acesso do desenvolvedor a este primeiro acesso do desenvolvedor a este módulo módulo módulo módulo. MÓDULO DE CADASTRO MÓDULO DE CADASTRO MÓDULO DE CADASTRO
MÓDULO DE CADASTRO DA PLATAFORMA BANRISULDA PLATAFORMA BANRISULDA PLATAFORMA BANRISUL DA PLATAFORMA BANRISUL
Neste módulo, o usuário poderá alterar os seguintes dados:
o Mensagem do boleto bancário;
6.1.1 6.1.1 6.1.1
6.1.1 Mensagem do boleto bancárioMensagem do boleto bancário Mensagem do boleto bancárioMensagem do boleto bancário
Para os credenciados que tiverem interesse na implantação de boleto bancário Banrisul, será possível utilizar este módulo para o registro das mensagens que serão impressas no campo “instruçãoinstruçãoinstruçãoinstrução” do referido boleto.
CONFIGURAÇÃO D CONFIGURAÇÃO D CONFIGURAÇÃO D
CONFIGURAÇÃO DAS MENSAGENS DO BOLETO BANCÁRIOAS MENSAGENS DO BOLETO BANCÁRIOAS MENSAGENS DO BOLETO BANCÁRIOAS MENSAGENS DO BOLETO BANCÁRIO BANRISULBANRISULBANRISULBANRISUL
A mensagem do boleto bancário é de inteira responsabilidade do credenciado (loja virtual).
6.1.2 6.1.2 6.1.2
6.1.2 Alteração de senhaAlteração de senha Alteração de senhaAlteração de senha
O último item deste módulo permite a loja virtual alterar a senha de acesso, como forma de segurança, sempre que a loja virtual ou o desenvolvedor entenderem ser oportuno este procedimento.
6.2 6.2 6.2
6.2 Módulo de Módulo de Módulo de Módulo de procedimentos para procedimentos para procedimentos para procedimentos para homologaçãohomologaçãohomologaçãohomologação da plataforma Banrisulda plataforma Banrisulda plataforma Banrisulda plataforma Banrisul Neste módulo o desenvolvedor irá encontrar informações detalhadas para a realização de testes em sua loja e dos procedimentos para a homologação do site junto a Equipe Técnica do Banrisul. É importante frisar que a liberação da loja para o ambiente de produção, em caráter definitivo, somente ocorrerá após os procedimentos de validação do Banrisul e a sinalização do produto no site.
Para obter as informações da homologação, o desenvolvedor deve acessar o link: ww4.Banrisul.com.br/banricompras/link na guia “Fluxo de Fluxo de Fluxo de Fluxo de procedimentos para a homologação
procedimentos para a homologação procedimentos para a homologação
procedimentos para a homologação”, na opção “Informações para Informações para Informações para Informações para homologação homologação homologação homologação”. 6.3 6.3 6.3
6.3 Realização de testes pela loja virtualRealização de testes pela loja virtualRealização de testes pela loja virtualRealização de testes pela loja virtual
Para que o desenvolvedor possa verificar se o projeto está funcional, são disponibilizados um conjunto de códigos fictícios de Agência, conta corrente e senhas, que servirão para a realização dos testes simulados. Nestes testes o desenvolvedor poderá ver se o fluxo das vendas está ocorrendo perfeitamente entre o site da loja e a página do Banrisul, e se as transações estão sendo levadas a termo, desde a montagem do pedido na loja virtual, até a efetivação do pagamento e sua confirmação, na página do Banrisul.
6.4 6.4 6.4
6.4 Solicitação de homologação dSolicitação de homologação dSolicitação de homologação dSolicitação de homologação do site junto a Bo site junto a Bo site junto a Bo site junto a Banrisulanrisulanrisul VeroanrisulVeroVero Vero
Concluído o desenvolvimento da estrutura técnica do projeto, em consonância com os parâmetros definidos neste manual, e após a realização dos testes pela loja virtual através da simulação de vendas, o responsável pelo desenvolvimento deverá solicitar a homologação da loja virtual por e-mail ao suporte técnico do Banrisul.
O desenvolvedor deverá informar o link de acesso à página de teste, usuário e senha para login, modalidades de pagamento a serem homologadas e anexar ao e-mail os comprovantes que evidenciem que as formas de pagamento disponibilizadas foram testadas.
Homologação Homologação Homologação
Homologação ---- 51 3215 3624 srac@banrisul.com.br
Uma vez homologado o site pela Equipe de Homologação, a área Comercial da Banrisul Vero entrará em contato com o desenvolvedor da loja e lhe informará o endereço de produção da plataforma Banrisul e os parâmetros comerciais necessários à liberação da loja para a realização de vendas em caráter definitivo.
Salientamos que para a homologação em produção é primordial que o site esteja bem sinalizado, através da utilização do logo do Banrisul desde a tela inicial até a tela de meios de pagamentos, e que o produto Banricompras tenha condição de igualdade competitiva com os demais meios de pagamentos existentes no site, no que diz respeito a condições e prazos de parcelamento.
As imagens podem ser solicitadas junto à área Comercial da rede de adquirência Banrisul Vero.
Comercial ComercialComercial Comercial ---- 51 3215 2914 banrisul_cartoes_estrategia@banrisul.com.br Produtos ProdutosProdutos Produtos ---- 51 3215 1184 banrisul_cartoes_produtos@banrisul.com.br