Arquivo de retorno Boleto Bancário Formato XML

Transcrição

1 Arquivo de retorno Boleto Bancário Formato XML

2 Índice Capítulo Introdução... 3 Capítulo Arquivo Retorno Pedidos em Lote... 4 Capítulo Arquivo Retorno Pedido Individual... 6 Anexo Arquivo DTD do XML de retorno... 8 Página 2 de 8

3 Capítulo 1 Introdução Este documento tem como objetivo orientar os desenvolvedores / lojistas a utilizar o arquivo de retorno para compras realizadas com Boleto Bancário Bradesco. Este arquivo retorna os dados relativos às compras, no formato XML, caso prefira utilizar outro formato o Bradesco disponibiliza este mesmo serviço no formato texto. Para obter o arquivo retorno no formato TXT, deve consultar o Arquivo de retorno Boleto TXT.pdf. Página 3 de 8

4 Capítulo 2 Arquivo Retorno Pedidos em Lote Nessa modalidade, será devolvido ao cliente um arquivo contendo todos os pedidos de Boletos Gerados e Pagos na loja no período compreendido de 7 dias anteriores a data atual. Ex.: Data atual informada: 25/04/2011. O resultado (Arquivo XML) desta consulta será todas os Boletos Gerados e Pagos a partir do dia 18 (7 dias antes da data atual informada no parâmetro data ) até o dia 25 (data atual). Para verificar o formato do arquivo, por favor, consulte o Anexo 1 deste documento O arquivo de retorno referente às compras realizadas com Boleto Bancário Bradesco pode ser obtido diretamente através dos seguintes endereços: Ambiente de testes: XXXXXX&data=dd/mm/aaaa&Manager=<administrador_da_loja>&passwd=<Password_da_loja>& Ambiente de produção: XXX&data=dd/mm/aaaa&Manager=<administrador_da_loja>&passwd=<Password_da_loja>& Os parâmetros obrigatórios são: Merchantid: Número que identifica o estabelecimento no sistema de compras. Data: Data atual que esta sendo realizada a pesquisa. Deve ser enviada, obrigatoriamente, no formato dd/mm/aaaa. Manager: É o mesmo Manager para acesso ao gerenciador de compras do sistema de pagamentos Bradesco. Passwd: Senha de acesso. É a mesma senha de acesso usada em conjunto com o usuário (manager) para acesso ao gerenciador de compras do sistema de pagamentos Bradesco. A chamada da página que vai fornecer os dados de retorno das compras pode ser feita via GET ou POST, e vai devolver como resposta uma lista de compras, como o exemplo a seguir: Página 4 de 8

5 <?xml version="1.0" encoding="utf-8"?> - <DadosFechamento Parte="01" Total="01"> - <Bradesco> <Pedido Numero=" " Valor="3091" Data="24/04/11 16:22:01" LinhaDigitavel=" <Pedido Numero=" " Valor="3091" Data="23/04/11 09:57:47" LinhaDigitavel=" <Pedido Numero=" " Valor="3091" Data="22/04/11 09:57:58" LinhaDigitavel=" <Pedido Numero=" " Valor="3091" Data="20/04/11 09:58:03" LinhaDigitavel=" <Pedido Numero=" " Valor="3091" Data="19/04/11 15:44:17" LinhaDigitavel=" " Status="14" Erro="0" /> <Pedido Numero=" " Valor="3091" Data="19/04/11 13:51:44" LinhaDigitavel=" </Bradesco> </DadosFechamento> No anexo 1 deste documento é fornecido o arquivo DTD do XML acima. Para esta consulta (Arquivo Retorno XML Boleto Bancário Bradesco - Pedidos em Lote) todas as compras listadas estarão com o seguinte status: Status...Descrição *Boleto Bancário sem Retorno de Geração 10...Boleto Gerado (Boleto Bancário sem retorno para a loja) 11...Boleto Pago Manual (Boleto Bancário sem retorno para a loja) 21...Boleto Pago Igual (Boleto Bancário sem retorno para a loja) 22...Boleto Pago Menor (Boleto Bancário sem retorno para a loja) 23...Boleto Pago Maior (Boleto Bancário sem retorno para a loja) *Boleto Bancário com Retorno de Geração 13...Boleto Gerado (não informado a geração) 14...Boleto Gerado (informado a geração) 15...Boleto Pago 21...Boleto Pago Igual (Boleto Bancário com retorno para a loja) 22...Boleto Pago Menor (Boleto Bancário com retorno para a loja) 23...Boleto Pago Maior (Boleto Bancário com retorno para a loja) Página 5 de 8

6 Capítulo 3 Arquivo Retorno Pedido Individual Nessa modalidade, será devolvido ao cliente uma única linha contendo as informações de um pedido específico utilizando a opção Boleto Bancário Bradesco. Ex.: Data atual informada: 25/04/2011. O número de pedido solicitado será consultado, caso o pedido se encontre na base de Dados o arquivo XML será retornado. O período disponível na Base para consulta são os 6 últimos meses. Para verificar o formato do arquivo, por favor, consulte o Anexo 1 desse documento O arquivo de retorno referente às compras realizadas com Boleto Bancário Bradesco pode ser obtido diretamente através dos seguintes endereços: Ambiente de testes: =XXXXXX&data=dd/mm/aaaa&Manager=<administrador_da_loja>&passwd=<Password_da_loja>&Nu morder=xxxxxxxxxxxxxxxxx Ambiente de produção: XXXX&data=dd/mm/aaaa&Manager=<administrador_da_loja>&passwd=<Password_da_loja>&NumOrd er=xxxxxxxxxxxxxxxxxxx Os parâmetros obrigatórios são: Merchantid: Número que identifica o estabelecimento no sistema de compras. Data: Data atual que esta sendo realizada a pesquisa. Deve ser enviada, obrigatoriamente, no formato dd/mm/aaaa. Manager: É o mesmo Manager para acesso ao gerenciador de compras do sistema de pagamentos Bradesco. Passwd: Senha de acesso. É a mesma senha de acesso usada em conjunto com o usuário (manager) para acesso ao gerenciador de compras do sistema de pagamentos Bradesco. NumOrder: Número do pedido que se deseja pesquisar. A chamada da página que vai fornecer os dados de retorno das compras pode ser feita via GET ou POST, e vai devolver como resposta uma lista de compras, como o exemplo a seguir: Página 6 de 8

7 <?xml version="1.0" encoding="utf-8"?> - <DadosFechamento Parte="01" Total="01"> - <Bradesco> <Pedido Numero=" " Valor="3091" Data="19/01/11 15:44:17" LinhaDigitavel=" " Status="14" Erro="0" /> </Bradesco> </DadosFechamento> Para esta consulta (Arquivo Retorno XML Boleto Bancário Bradesco - Pedido Individual) todas as compras listadas estarão com o seguinte status: Status...Descrição 00...Boleto não Gerado Erro<>0 Indica o erro *Boleto Bancário sem Retorno de Geração 10...Boleto Gerado (Boleto Bancário sem retorno para a loja) 11...Boleto Pago Manual (Boleto Bancário sem retorno para a loja) 21...Boleto Pago Igual (Boleto Bancário sem retorno para a loja) 22...Boleto Pago Menor (Boleto Bancário sem retorno para a loja) 23...Boleto Pago Maior (Boleto Bancário sem retorno para a loja) *Boleto Bancário com Retorno de Geração 13...Boleto Gerado (não informado a geração) 14...Boleto Gerado (informado a geração) 15...Boleto Pago 21...Boleto Pago Igual (Boleto Bancário com retorno para a loja) 22...Boleto Pago Menor (Boleto Bancário com retorno para a loja) 23...Boleto Pago Maior (Boleto Bancário com retorno para a loja) Página 7 de 8

8 Anexo 1 Arquivo DTD do XML de retorno Todas as compras serão devolvidas segundo o DTD abaixo: O DTD abaixo se aplica tanto para XML com um único pedido quanto para os XML de pedidos em lote. <?xml version="1.0"?> <!ELEMENT DadosFechamento (Bradesco)> <!ELEMENT Bradesco (Pedido)> <!ELEMENT Pedido EMPTY> <!ATTLIST DadosFechamento Parte CDATA #REQUIRED> <!ATTLIST DadosFechamento Total CDATA #REQUIRED> <!ATTLIST Pedido Numero CDATA #REQUIRED> <!ATTLIST Pedido Valor CDATA #REQUIRED> <!ATTLIST Pedido Data CDATA #REQUIRED> <!ATTLIST Pedido LinhaDigitavel CDATA #REQUIRED> <!ATTLIST Pedido Status CDATA #REQUIRED> <!ATTLIST Pedido Erro CDATA #REQUIRED> Página 8 de 8