Guia de Integração Assinatura Manual

Transcrição

1 Guia de Integração Assinatura Manual

2 API DE ASSINATURA MANUAL 2 Histórico de Versões DATA 09/04/2012 Visão Geral 17/06/2014 Revisão 25/08/2014 Revisão Copyright Todos os direitos reservados. O UOL é uma marca comercial do UNIVERSO ONLINE S / A. O logotipo do UOL é uma marca comercial do UNIVERSO ONLINE S / A. Outras marcas, nomes, logotipos e marcas são de propriedade de seus respectivos proprietários. As informações contidas neste documento pertencem ao UNIVERSO ONLINE S/A. Todos os direitos reservados. UNIVERSO ONLINE S/A. - Av. Faria Lima, 1384, 6º andar, São Paulo / SP, CEP , Brasil. O serviço PagSeguro não é, nem pretende ser comparável a serviços financeiros oferecidos por instituições financeiras ou administradoras de cartões de crédito, consistindo apenas de uma forma de facilitar e monitorar a execução das transações de comércio electrónico através da gestão de pagamentos. Qualquer transação efetuada através do PagSeguro está sujeita e deve estar em conformidade com as leis da República Federativa do Brasil. Aconselhamos que você leia os termos e condições cuidadosamente. Aviso Legal O UOL não oferece garantias de qualquer tipo (expressas, implícitas ou estatutárias) com relação às informações nele contidas. O UOL não assume nenhuma responsabilidade por perdas e danos (diretos ou indiretos), causados por erros ou omissões, ou resultantes da utilização deste documento ou a informação contida neste documento ou resultantes da aplicação ou uso do produto ou serviço aqui descrito. O UOL reserva o direito de fazer qualquer tipo de alterações a quaisquer informações aqui contidas sem aviso prévio.

3 API DE ASSINATURA MANUAL 3 O PagSeguro provê todas as ferramentas necessárias para que você efetue a sua integração de forma rápida e fácil. Confira abaixo nossas ferramentas e canais: Documentações Acessando a área de documentações do PagSeguro você tem acesso a todas as APIs disponíveis pelo PagSeguro. Acesse: Sandbox Teste sua integração de pagamento sem alterar as transações reais. Acesse: Fórum Participe da comunidade PagSeguro postando suas dúvidas e auxiliando outros desenvolvedores em nosso fórum. Nossa equipe está sempre presente para lhe auxiliar. Acesse: Módulos Desenvolvemos módulos para que você possa integrar o PagSeguro em diversas plataformas de e-commerce com ainda mais facilidade. Acesse: Bibliotecas Disponibilizamos bibliotecas em várias linguagens e tutoriais para que você possa integrar o PagSeguro com em sua loja virtual, site ou blog. Acesse:

4 API DE ASSINATURA MANUAL 4 Índice Histórico de Versões... 2 Copyright... 2 Aviso Legal... 2 Índice... 4 Visão Geral... 6 Etapas da Integração... 6 Autorização... 6 Assinatura com cobrança manual... 7 Requisição de Assinatura Manual... 9 Informando os dados em parâmetros HTTP... 9 Informando os dados em formato Resposta da API de Pagamentos Direcionando o comprador para o fluxo de pagamento Checkout com assinatura associada Informando os dados em formato Resposta da API de Pagamentos Direcionando o comprador para o fluxo de pagamento Notificação Notificação de assinatura Notificação de transação Consulta de assinaturas Consultando pelo código de notificação Consultando pelo código da assinatura Consultando por intervalo de dias Consultando por intervalo de data Consulta de transações... 22

5 API DE ASSINATURA MANUAL 5 Cobrança Efetuando uma cobrança não presencial Informando os dados em parâmetros HTTP Informando os dados em formato Resposta do Serviço de Cobrança Cancelando uma assinatura Parâmetros de autenticação Parâmetros de requisição Parâmetros de resposta da assinatura Parâmetros de cobrança Parâmetros de resposta da requisição de cobrança Parâmetros de notificação Parâmetros de consulta por notificação Parâmetros de consulta pelo código da assinatura Parâmetros de retorno da consulta por código de notificação ou código de assinatura.. 35 Parâmetros de retorno de consulta por histórico ou por intervalo Parâmetros de cancelamento Parâmetros de retorno do cancelamento Parâmetros de erro Tabela de Erros... 42

6 API DE ASSINATURA MANUAL 6 Visão Geral O modelo de assinaturas do PagSeguro permite que sua empresa ofereça aos seus compradores serviços com pagamentos recorrentes de forma fácil e segura. Seja uma assinatura de revista, mensalidade de um curso, conteúdo exclusivo ou qualquer modelo que necessite de uma cobrança recorrente, o modelo de assinaturas do PagSeguro proporciona uma forma completa de criar cobranças não presenciais previamente autorizadas pelo comprador, maximizando assim a fidelização. O modelo de assinaturas do PagSeguro está disponível apenas para contas do tipo Vendedor e Empresarial e aceita apenas pagamentos com cartão de crédito. Etapas da Integração A integração possui algumas etapas básicas: 1. Autorização Direcione o comprador para o site do PagSeguro onde ele fará o processo de autorização de pagamento recorrente com segurança e conveniência. 2. Notificação Receba notificações informando o status da autorização e das cobranças. 3. Cobrança Efetive a cobrança das autorizações recebidas. 4. Consulta e Cancelamento Faça consultas ao PagSeguro para acompanhar a qualquer momento as suas transações. Você também pode cancelar uma assinatura vigente. Autorização A autorização é o processo onde o cliente, após escolher o serviço no site é redirecionado para o PagSeguro para efetuar a autorização de débito recorrente em seu cartão de crédito. Veja a representação do fluxo na Imagem 1. Imagem 1

7 API DE ASSINATURA MANUAL 7 A imagem anterior representa o fluxo na visão do comprador, ou seja, do cliente que acessa a sua loja. Na visão do desenvolvedor, temos uma requisição para a API de Assinatura, demonstrada na Imagem 2. Imagem 2 A loja faz uma chamada para o Serviço de Requisição de Assinatura passando todos os parâmetros da cobrança. O PagSeguro, após validar e armazenar os dados da assinatura devolverá um código identificador para que o seu site redirecione o cliente para a tela de autorização de assinatura. Atenção: O código identificador retornado na chamada acima não é o código da assinatura e sim apenas um token para redirecionar o cliente para o checkout. O código da assinatura é retornado no final do processo de assinatura pelo cliente que será visto mais à frente. Entre os parâmetros enviados constam informações como a descrição da assinatura, valor a ser cobrado, a periodicidade da cobrança e etc. Também é possível definir de que forma as cobranças serão realizadas, ou seja, definir se a assinatura será cobrada automaticamente pelo PagSeguro ou manualmente pelo seu sistema. Temos assim dois formatos de integração: Automática ou Manual. Este documento trata do formato Manual. Veja abaixo as suas características: Assinatura com cobrança manual Neste modelo, fica ao seu encargo efetuar as cobranças, desde que as regras definidas na assinatura e aceitas pelo comprador sejam respeitadas. No modelo de assinatura Manual a primeira cobrança é efetuada no final do período, como uma cobrança de serviço de telefonia, por exemplo. Com a Assinatura Manual também é possível criar um checkout com uma assinatura associada. Assim você pode efetuar uma cobrança de um produto ou serviço no ato da compra e iniciar uma assinatura, na qual será cobrada no final do período.

8 API DE ASSINATURA MANUAL 8 Exemplo de Assinatura: O cliente contratou no dia 21/01 um serviço/produto no valor de R$ 50,00 com cobrança recorrente a cada mês. Seu sistema poderá, através de uma requisição o Serviço de Cobrança, solicitar ao PagSeguro o primeiro débito no dia 21/02 no valor de R$ 50,00 e também nos meses subsequentes. Neste exemplo, todas as requisições o Serviço de Cobrança são feitas pelo seu sistema. Caso sua aplicação efetue uma cobrança fora do prazo ou fora das definições pré-estabelecidas, estas serão negadas pelo PagSeguro em respeito as regras definidas e aceitas pelo comprador. Exemplo de Checkout com Assinatura Associada: O cliente comprou no dia 21/01 um eletrônico no valor de R$ 200,000 e, junto ao checkout contratou um serviço de suporte no valor de R$ 30,00 com cobrança recorrente a cada mês. Seu sistema poderá, através de uma requisição a API de Pagamento, encaminhar o cliente ao PagSeguro para que ele efetue o pagamento no ato do produto no valor de R$ 200,00 e, após a aprovação deste débito é ativada a assinatura com o primeiro débito no dia 21/02 no valor de R$ 30,00, como também nos meses subsequentes. Neste exemplo, todas as requisições o Serviço de Cobrança feitas pelo seu sistema. Caso sua aplicação efetue uma cobrança fora do prazo ou fora das definições préestabelecidas, estas serão negadas pelo PagSeguro em respeito as regras definidas e aceitas pelo comprador. Veja na tabela abaixo as principais diferenças entre os modelos Automático e Manual: SITUAÇÃO MODELO AUTOMÁTICO MODELO MANUAL Cobrança Retentativa de cobrança em caso de cobrança sem sucesso por falta de saldo ou cartão fora da validade. Tipo de cobrança O PagSeguro fica responsável por efetuar as cobranças com a periodicidade informada na criação da assinatura. O modelo automático não contempla retentativas. Uma vez perdida a cobrança, no próximo será cobrado somente o valor do mês corrente. O valor que ficou em aberto deve ser cobrado através de um envio de cobrança ou de outra forma escolhida. Permite somente o modelo prépago, ou seja, o cliente é cobrado no ato da assinatura e nos meses seguintes até o final da vigência. O seu sistema fica responsável por efetuar as cobranças com a periodicidade informada na criação da assinatura. No modelo manual você pode efetuar uma nova chamada para o Serviço de cobrança efetuando a retentativa, desde que esteja dentro do prazo estipulado na criação da assinatura. Permite os modelos pré e pós pago onde você efetua a cobrança no final do período, como em uma conta de telefone. A seleção do formato da assinatura é feita através chamada ao Serviço de Requisições do PagSeguro pelo parâmetro charge (charge para e preapprovalcharge para HTTP) que pode ser definido como auto para o formato Automático ou manual para o formato Manual. Nesta documentação, todas as chamadas serão efetuadas utilizando o parâmetro com o valor manual. Vejamos abaixo como funciona o Serviço de Requisição de Assinatura para cada um dos modelos.

9 API DE ASSINATURA MANUAL 9 Requisição de Assinatura Manual Para iniciar uma assinatura manual, você precisa fazer uma chamada o Serviço de Requisição do PagSeguro informando os dados do serviço recorrente e passando no parâmetro charge a opção manual. Esta requisição cria um código identificador para que você possa redirecionar o cliente para o PagSeguro, onde ele prosseguirá com o fluxo de autorização conforme demonstrado na Imagem 2. No modelo de assinatura manual fica ao encargo do seu sistema efetuar as cobranças, desde que as regras definidas na assinatura e aceitas pelo comprador sejam respeitadas. Você pode informar os dados da assinatura de duas formas: em parâmetros HTTP ou em formato. Informando os dados em parâmetros HTTP Uma forma de fazer a requisição à API de Pagamentos é informar os dados do pagamento diretamente em parâmetros HTTP utilizando o método POST. URL da API de Pagamentos do PagSeguro: POST O cabeçalho Content-Type deve ser informado como no exemplo abaixo: Content-Type: application/x-www-form-urlencoded; charset=iso Observação: caso sua aplicação ou loja não utilize o conjunto de caracteres ISO , p.e.(utf-8), é necessário substituir o parâmetro charset do exemplo acima. Veja abaixo um exemplo completo de uma requisição para a API de Pagamento do PagSeguro informando os dados do pagamento em parâmetros HTTP (as linhas foram quebradas para facilitar a leitura). curl -k -d\ " ={mail}\ &token={token}\ &sendername=nome do Cliente\ &senderareacode=11\ &senderphone= \ &sender =cliente@dominio.com.br\ &senderaddressstreet=avenida Brigadeiro Faria Lima\ &senderaddressnumber=1384\ &senderaddresscomplement=1 Andar\ &senderaddressdistrict=jardim Paulistano\ &senderaddresspostalcode= \ &senderaddresscity=são Paulo\ &senderaddressstate=sp\ &senderaddresscountry=bra\ &preapprovalcharge=manual\ &preapprovalname=seguro contra roubo do Notebook Prata\

10 API DE ASSINATURA MANUAL 10 &preapprovaldetails=todo dia 28 será cobrado o valor de R100,00 referente ao seguro contra roubo do Notebook Prata.\ &preapprovalamountperpayment=100.00\ &preapprovalmaxamountperpayment=100.00\ &preapprovalperiod=monthly\ &preapprovalmaxpaymentsperperiod=2\ &preapprovalmaxamountperperiod=200.00\ &preapprovalinitialdate= t00:00:000-03:00\ &preapprovalfinaldate= t00:00:000-03:00\ &preapprovalmaxtotalamount= &reference=ref1234\ &redirecturl= &reviewurl= Informando os dados em formato Outra forma de fazer a requisição à API de Pagamentos é informar os dados do pagamento no formato, esta forma pode ser mais interessante se você já trabalha com em seu sistema e prefere estruturar os dados do pagamento neste formato. Veja abaixo os cabeçalhos HTTP necessários para fazer uma requisição à API de Pagamentos do PagSeguro informando os dados no formato. URL da API de Assinatura do PagSeguro: O cabeçalho Content-Type deve ser informado como no exemplo abaixo: Content-Type: application/xml; charset=iso Observação: caso sua aplicação ou loja não utilize o conjunto de caracteres ISO , p.e.(utf-8), é necessário substituir o parâmetro charset do exemplo acima. Veja abaixo exemplo de estruturado para representar os dados de um pagamento: <redirecturl> 3. <reference>ref1234</reference> 4. <sender> 5. <name>nome do Cliente</name> 6. < >cliente@dominio.com.br</ > 7. <phone> 8. <areacode>11</areacode> 9. <number> </number> 10. </phone> 11. <address> 12. <street>avenida Brigadeiro Faria Lima</street>

11 API DE ASSINATURA MANUAL <number>1384</number> 14. <complement>1 Andar</complement> 15. <district>jardim Paulistano</district> 16. <postalcode> </postalcode> 17. <city>são Paulo</city> 18. <state>sp</state> 19. <country>bra</country> 20. </address> 21. </sender> <charge>manual</charge> 24. <name>seguro contra roubo do Notebook Prata</name> 25. <details>será cobrado R$100,00 referente ao seguro</details> 26. <amountperpayment>100.00</amountperpayment> 27. <maxamountperpayment>100.00</maxamountperpayment> 28. <period>monthly</period> 29. <maxpaymentsperperiod>2</maxpaymentsperperiod> 30. <maxamountperperiod>200.00</maxamountperperiod> 31. <initialdate> t00:00:000-03:00</initialdate> 32. <finaldate> t00:00:000-03:00</finaldate> 33. <maxtotalamount> </maxtotalamount> 34. </preapproval> 35. </preapprovalrequest> Os parâmetros desta requisição estão descritos na listagem de parâmetros. Resposta da API de Pagamentos A resposta é dada em formato. O exemplo abaixo mostra uma resposta de sucesso a uma chamada à API de assinatura: <code>dc2dac98fbfbdd f94e85fae05</code> 3. <date> t16:11: :00</date> 4. </preapprovalrequest> Os parâmetros de resposta desta requisição estão descritos na listagem de parâmetros.

12 API DE ASSINATURA MANUAL 12 Caso ocorra algum erro na chamada à API de Pagamentos, seja algum erro nos parâmetros informados ou alguma falha técnica no sistema, uma resposta de erro será retornada, como no exemplo abaixo. Ela indicará todos os erros identificados na chamada: 1. <errors> 2. <error> 3. <code>11004</code> 4. <message>currency is required.</message> 5. </error> 6. </errors> Os parâmetros de erro estão descritos na listagem de parâmetros. Direcionando o comprador para o fluxo de pagamento Após realizar uma chamada com sucesso à API de Pagamentos, você deve direcionar o comprador para o fluxo de pagamento, usando o código de requisição retornado. O exemplo abaixo mostra uma URL montada para que o usuário inicie um fluxo de pagamento. Atenção: A presença do código de requisição retornado pela chamada à API de assinatura do PagSeguro é obrigatório Checkout com assinatura associada No modelo manual você também pode criar um checkout e associar uma assinatura no mesmo momento. Veja abaixo como criar este tipo de checkout: Informando os dados em parâmetros HTTP Uma forma de fazer a requisição à API de Pagamentos é informar os dados do pagamento diretamente em parâmetros HTTP utilizando o método POST. URL da API de Pagamentos do PagSeguro: POST O cabeçalho Content-Type deve ser informado como no exemplo abaixo: Content-Type: application/x-www-form-urlencoded; charset=iso Observação: caso sua aplicação ou loja não utilize o conjunto de caracteres ISO , p.e.(utf-8), é necessário substituir o parâmetro charset do exemplo acima. Veja abaixo um exemplo completo de uma requisição para a API de Pagamento do PagSeguro informando os dados do pagamento em parâmetros HTTP (as linhas foram quebradas para facilitar a leitura).

13 API DE ASSINATURA MANUAL 13 curl -k -d\ " ={mail}\ &token={token}\ &currency=brl\ &itemid1=0001\ &itemdescription1=notebook Prata\ &itemamount1= \ &itemquantity1=1\ &itemweight1=1000\ &reference=ref1234\ &sendername=nome do Cliente\ &senderareacode=11\ &senderphone= \ &shippingtype=1\ &shippingaddressstreet=avenida Brigadeiro Faria Lima\ &shippingaddressnumber=1384\ &shippingaddresscomplement=1 Andar\ &shippingaddressdistrict=jardim Paulistano\ &shippingaddresspostalcode= \ &shippingaddresscity=são Paulo\ &shippingaddressstate=sp\ &shippingaddresscountry=bra\ &preapprovalcharge=manual\ &preapprovalname=seguro contra roubo do Notebook Prata\ &preapprovaldetails=todo dia 28 será cobrado o valor de R100,00 referente ao seguro contra roubo do Notebook Prata.\ &preapprovalamountperpayment=100.00\ &preapprovalmaxamountperpayment=100.00\ &preapprovalperiod=monthly\ &preapprovalmaxpaymentsperperiod=2\ &preapprovalmaxamountperperiod=200.00\ &preapprovalinitialdate= t00:00:000-03:00\ &preapprovalfinaldate= t00:00:000-03:00\

14 API DE ASSINATURA MANUAL 14 &preapprovalmaxtotalamount= &reference=ref1234\ &redirecturl= &reviewurl= Informando os dados em formato Outra forma de fazer a requisição à API de Pagamentos é informar os dados do pagamento no formato, esta forma pode ser mais interessante se você já trabalha com em seu sistema e prefere estruturar os dados do pagamento neste formato. Veja abaixo os cabeçalhos HTTP necessários para fazer uma requisição à API de Pagamentos do PagSeguro informando os dados no formato. URL da API de Assinatura do PagSeguro: O cabeçalho Content-Type deve ser informado como no exemplo abaixo: Content-Type: application/xml; charset=iso Observação: caso sua aplicação ou loja não utilize o conjunto de caracteres ISO , p.e.(utf-8), é necessário substituir o parâmetro charset do exemplo acima. Veja abaixo exemplo de estruturado para representar os dados de um pagamento: 1. <checkout> 2. <currency>brl</currency> 3. <items> 4. <item> 5. <id>0001</id> 6. <description>notebook Prata</description> 7. <amount> </amount> 8. <quantity>1</quantity> 9. <weight>1000</weight> 10. </item> 11. </items> 12. <reference>ref1234</reference> 13. <sender> 14. <name>nome do Cliente</name> 15. < >cliente@dominio.com.br</ > 16. <phone> 17. <areacode>11</areacode> 18. <number> </number> 19. </phone> 20. </sender>

15 API DE ASSINATURA MANUAL <shipping> 22. <type>1</type> 23. <address> 24. <street>avenida Brigadeiro Faria Lima</street> 25. <number>1384</number> 26. <complement>1 Andar</complement> 27. <district>jardim Paulistano</district> 28. <postalcode> </postalcode> 29. <city>são Paulo</city> 30. <state>sp</state> 31. <country>bra</country> 32. </address> 33. </shipping> 34. <redirecturl> 35. <reviewurl> <charge>manual</charge> 38. <name>seguro contra roubo do Notebook Prata</name> 39. <details>todo dia 28 será cobrado o valor de R$100,00 referente ao seguro contra roubo do Notebook Prata</details> 40. <amountperpayment>100.00</amountperpayment> 41. <maxamountperpayment>100.00</maxamountperpayment> 42. <period>monthly</period> 43. <maxpaymentsperperiod>2</maxpaymentsperperiod> 44. <maxamountperperiod>200.00</maxamountperperiod> 45. <initialdate> t00:00:000-03:00</initialdate> 46. <finaldate> t00:00:000-03:00</finaldate> 47. <maxtotalamount> </maxtotalamount> 48. </preapproval> 49. </checkout> Os parâmetros desta requisição estão descritos na listagem de parâmetros.

16 API DE ASSINATURA MANUAL 16 Resposta da API de Pagamentos A resposta é dada em formato. O exemplo abaixo mostra uma resposta de sucesso a uma chamada à API de assinatura: 1. <checkout> 2. <code>8cf4be7dcecef0f004a6dfa0a </code> 3. <date> t10:11: :00</date> 4. </checkout>as tabelas abaixo descrevem os parâmetros retornados. Os parâmetros de resposta desta requisição estão descritos na listagem de parâmetros. Caso ocorra algum erro na chamada à API de Pagamentos, seja algum erro nos parâmetros informados ou alguma falha técnica no sistema, uma resposta de erro será retornada, como no exemplo abaixo. Ela indicará todos os erros identificados na chamada: 1. <errors> 2. <error> 3. <code>11004</code> 4. <message>currency is required.</message> 5. </error> 6. <error> 7. <code>11005</code> 8. <message>currency invalid value: ValorCurrencyInvalido</message> 9. </error> 10. </errors> Os parâmetros de erro estão descritos na listagem de parâmetros.

17 API DE ASSINATURA MANUAL 17 Direcionando o comprador para o fluxo de pagamento Após realizar uma chamada com sucesso à API de Pagamentos, você deve direcionar o comprador para o fluxo de pagamento, usando o código de requisição retornado. O exemplo abaixo mostra uma URL montada para que o usuário inicie um fluxo de pagamento. Atenção: Existem pontos importantes sobre a requisição de assinatura que devem ser levados em conta no momento do desenvolvimento. Parâmetros que definem data e periodicidade Esses parâmetros são utilizados para definir a periodicidade da assinatura. preapprovalinitialdate preapprovalfinaldate preapprovalperiod <initialdate> <finaldate> <period> Parâmetros que definem valores e limites Os parâmetros de valor da cobrança são utilizados para definir o valor máximo cobrado por período e o valor máximo cobrado em todo o tempo de vigência da assinatura. É importante prestar atenção na regra do parâmetro, pois, por exemplo, ao selecionar a opção em preapprovalmaxamountperperiod ou em <maxamountperperiod> e com valor de , este será o valor máximo aceito para cobrança por mês. Se o seu sistema necessita cobrar um valor extra caso o cliente, por exemplo, atinja uma cota x do serviço, é recomendado que você informe o cliente deste ponto e defina o maxamountperperiod para o valor necessário. Os parâmetros que definem esses valores são: preapprovalmaxamountperperiod preapprovalmaxtotalamount preapprovalamountperpayment preapprovalmaxamountperpayment preapprovalmaxpaymentsperperiod <maxamountperperiod> <maxtotalamount> <amountperpayment> <maxamountperpayment> <maxpaymentsperperiod>

18 API DE ASSINATURA MANUAL 18 Notificação O PagSeguro encaminha notificações ao seu sistema para que você possa obter informações das transações e assinaturas geradas e suas mudanças de status. A Imagem 3 ilustra o funcionamento do Serviço de Notificações. Note que é o PagSeguro que inicia o processo de notificação ao enviar um código para seu sistema. Imagem 3 Você pode definir a URL de notificação de duas maneiras: Através da página de configurações do PagSeguro através do endereço: Através do envio do parâmetro notificationurl na criação da assinatura. Uma vez configurado o endereço para onde o PagSeguro irá enviar notificações, o próximo passo é preparar seu sistema para receber, nesse endereço, um código de notificação. Quando uma assinatura for criada, você receberá dois tipos de se notificação: notificações de assinatura e notificações de transação. Notificação de assinatura As notificações de assinatura possuem os dados da assinatura como também o seu status e as permissões concedidas. O PagSeguro envia as notificações de assinatura para a URL que você configurou usando o protocolo HTTP, pelo método POST.

19 API DE ASSINATURA MANUAL 19 Veja abaixo um exemplo de notificação de assinatura enviada pelo PagSeguro (as linhas foram quebradas para facilitar a leitura): POST HTTP/1.1 Host:pagseguro.uol.com.br Content-Length:85 Content-Type:application/x-www-form-urlencoded notificationcode=766b9c-ad4b044b04da-77742f5fa653-e1ab24 &notificationtype=preapproval Notificação de transação As notificações de transação possuem os dados da transação como por exemplo os valores cobrados, código da transação, itens e o status da transação. O PagSeguro envia as notificações de assinatura para a URL que você configurou usando o protocolo HTTP, pelo método POST. Veja abaixo um exemplo de notificação de assinatura enviada pelo PagSeguro (as linhas foram quebradas para facilitar a leitura): POST HTTP/1.1 Host:pagseguro.uol.com.br Content-Length:85 Content-Type:application/x-www-form-urlencoded notificationcode=566b9c-ad4b044b04da-77742f5fa653-e1ab24 &notificationtype=transaction Veja que as notificações de transação e assinatura possuem o notificationtype distintos: Para notificações de transação é recebido um notificationtype=transaction e, para notificações de assinatura é recebido um notificationtype=preapproval. Note que a notificação não possui nenhuma informação sobre a transação/assinatura. Portanto, assim que seu sistema recebe uma notificação, ele deve consulta-la para obter os dados da transação. Atenção: Caso o seu sistema fique fora do ar, o PagSeguro reenviará as notificações a cada 2 horas, até um máximo de 5 tentativas. Se seu sistema ficar indisponível por um período maior que este, será possível obter os dados de suas transações usando a Consulta de Assinatura por Intervalo de Datas que será descrito no próximo tópico Consulta de assinaturas Para consultar dados de uma assinatura a loja deve fazer uma requisição informando, além das credenciais, os dados necessários para a consulta usando o método HTTP GET.

20 API DE ASSINATURA MANUAL 20 Consultando pelo código de notificação Esta consulta deve ser utilizada para consultar uma notificação recebida a fim de obter os dados da assinatura. GET notifications/d2e5c7-5145ce45ce78-e7746d3fac62-b1782b? ={ }&token={token} Consultando pelo código da assinatura Esta consulta possibilita o acesso a todos os dados de uma assinatura a partir de seu código identificador. GET ={ }&token={token} Para ambas as consultas acima, a resposta é dada em formato, como no exemplo abaixo <name>seguro contra roubo do Notebook Prata</name> 3. <code>c e9edf3dd4023f87b71de349</code> 4. <date> t13:40: :00</date> 5. <tracker>538c53</tracker> 6. <status>cancelled</status> 7. <reference>ref1234</reference> 8. <lasteventdate> t20:04: :00</lasteventdate> 9. <charge>auto</charge> 10. <sender> 11. <name>comprador Istambul</name> 12. < >c@i.com</ > 13. <phone> 14. <areacode>11</areacode> 15. <number> </number> 16. </phone> 17. <address> 18. <street>alameda ITU</street> 19. <number>78</number> 20. <complement>ap. 2601</complement> 21. <district>jardim Paulista</district> 22. <city>sao PAULO</city> 23. <state>sp</state> 24. <country>brasil</country> 25. <postalcode> </postalcode> 26. </address> 27. </sender> 28. </preapproval>

21 API DE ASSINATURA MANUAL 21 Os parâmetros destas requisições e os parâmetros de retorno desta chamada estão descritos na listagem de parâmetros. Também é possível efetuar pesquisas por intervalo de data e por histórico de assinatura. Consultando por intervalo de dias Permite o acesso aos dados de todas as assinaturas que tiveram algum tipo de notificação dentro de um intervalo de tempo (em dias) definido. Consultando por intervalo de data Obtém os dados das assinaturas dado um intervalo de datas T00:00&finalDate= T00:00&maxPageResults=2&page=1 Para as consultas por intervalo de dias e de data, o resultado é apresentado em conforme o exemplo abaixo: 1. <preapprovalsearchresult> 2. <resultsinthispage>1</resultsinthispage> 3. <currentpage>1</currentpage> 4. <totalpages>1</totalpages> 5. <date> t16:16: :00</date> 6. <preapprovals> <name>pagseguro Pre Approval</name> 9. <code>12e10bef5e5ef fb891c8e4cf</code> 10. <date> t11:06: :00</date> 11. <tracker>624c17</tracker> 12. <status>initiated</status> 13. <reference>r123456</reference> 14. <lasteventdate> t15:37: :00</lasteventdate> 15. <charge>auto</charge> 16. </preapproval> 17. </preapprovals> 18. </preapprovalsearchresult> Os parâmetros destas requisições e os parâmetros de retorno desta chamada estão descritos na listagem de parâmetros.