Modelo Aplicacoes PT BR v2

GUIA DE INTEGRAO ASSINATURA 1
VERSO 1.0.2

Guia de Integrao
Plataformas de e-commerce com Modelo
de Aplicaes


VERSO 1.0.2


VERSO 1.0.2
Histrico de Verses

DATA DESCRIO
26/02/2013 Viso Geral
13/03/2013 Reviso
03/05/2013 Adio de sugesto de criao de conta

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 so de propriedade de seus respectivos proprietrios.
As informaes contidas neste documento pertencem ao UNIVERSO ONLINE S/A. Todos os
direitos reservados. UNIVERSO ONLINE S/A. - Av. Faria Lima, 1384, 6 andar, So Paulo / SP,
CEP 01452-002, Brasil.
O servio PagSeguro no , nem pretende ser comparvel a servios financeiros oferecidos por
instituies financeiras ou administradoras de cartes de crdito, consistindo apenas de uma
forma de facilitar e monitorar a execuo das transaes de comrcio electrnico atravs da
gesto de pagamentos. Qualquer transao efetuada atravs do PagSeguro est sujeita e deve
estar em conformidade com as leis da Repblica Federativa do Brasil.
Aconselhamos que voc leia os termos e condies cuidadosamente.

Aviso Legal
O UOL no oferece garantias de qualquer tipo (expressas, implcitas ou estatutrias) com
relao s informaes nele contidas. O UOL no assume nenhuma responsabilidade por
perdas e danos (diretos ou indiretos), causados por erros ou omisses, ou resultantes da
utilizao deste documento ou a informao contida neste documento ou resultantes da
aplicao ou uso do produto ou servio aqui descrito. O UOL reserva o direito de fazer
qualquer tipo de alteraes a quaisquer informaes aqui contidas sem aviso prvio.


VERSO 1.0.2
ndice
Histrico de Verses ................................................................................................. 3
Copyright ................................................................................................................. 3
Aviso Legal ............................................................................................................... 3
Viso Geral ............................................................................................................... 5
Etapas da Integrao ................................................................................................ 5
Aplicaes ................................................................................................................ 6
Autorizao .............................................................................................................. 9
Informando os dados da requisio ....................................................................... 10
Dados do cliente e sugesto para cadastro ............................................................ 12
Resposta da API de Autorizao ............................................................................. 18
Direcionando o comprador para o fluxo de autorizao ....................................... 20
Fluxo de autorizao ............................................................................................... 20
Revogao de autorizao ...................................................................................... 22
Pagamentos e Assinaturas ...................................................................................... 24
Pagamentos ............................................................................................................ 24
Assinaturas ............................................................................................................. 24
Notificaes ........................................................................................................... 25
Configurando o recebimento de notificaes ........................................................ 25
Recebendo uma notificao de transao ............................................................. 25
Consultas ............................................................................................................... 27
Consultando uma autorizao pelo cdigo de notificao .................................... 27
Consultando uma autorizao pelo seu cdigo ..................................................... 28
Consultando todas as autorizaes da aplicao ................................................... 30
Tabela de Erros ....................................................................................................... 34


VERSO 1.0.2
Viso Geral

O modelo de aplicaes do PagSeguro permite que sua aplicao crie checkouts, receba
notificaes de pagamento, efetue consultas,entre outras funes em nome do cliente sem
que este necessite configurar tokens, URL de retorno e outras informaes em sua conta
PagSeguro.

Atualmente, o modelo de aplicaes do PagSeguro est disponvel para contas do tipo
Vendedor e Empresarial.

Etapas da Integrao

A integrao do Modelo de Aplicaes possui algumas etapas bsicas:

1. Aplicaes

Crie e gerencie uma aplicao.

2. Autorizao

Obtenha a permisso do seu cliente para criar checkouts, efetuar
consultas entre outras aes.

3. Pagamentos

Crie checkouts e direcione o comprador para o site do PagSeguro,
onde ele far o pagamento com segurana e convenincia

4. Notificaes

Receba notificaes informando o status da autorizao e das
cobranas.

5. Consulta

Faa consultas ao PagSeguro para acompanhar a qualquer
momento as suas transaes.


VERSO 1.0.2
Aplicaes

Para utilizar o modelo de aplicaes do PagSeguro necessrio que voc crie uma aplicao.
Esta aplicao ser responsvel por centralizar as autorizaes concedidas pelos seus clientes.

Para criar uma nova aplicao, autentique-se no PagSeguro e acesse o link
https://pagseguro.uol.com.br/aplicacao/listagem.jhtml. Clique em criar suas aplicaes
conforme apresentado na Imagem 1:

Imagem 1

Voc tambm pode acessar diretamente a pgina de cadastro atravs do link
https://pagseguro.uol.com.br/aplicacao/cadastro.jhtml.

Na pgina de criao, voc deve preencher os dados solicitados, que so:

CAMPO DESCRIO
Nome da aplicao
Esse nome ir aparecer para voc e para seus clientes que usaro
sua aplicao.

ID da Aplicao

O ID da aplicao ser o cdigo que identifica esta aplicao no
PagSeguro.

Obs.: O PagSeguro ir sugerir um ID a partir do nome que voc
escolheu no campo anterior.

Descrio da aplicao
Escreva a descrio que ir aparecer para seus clientes de sua
aplicao. Procure ser objetivo e explicar resumidamente a sua
funo.


VERSO 1.0.2
CAMPO DESCRIO
URL da aplicao
Digite a URL em que a sua aplicao estar disponvel para acesso na
internet. Pode ser entendida como a URL por onde o cliente iniciar
a integrao no seu site.

Logomarca
Informe o endereo (URL) da sua logomarca ou faa upload do
arquivo de imagem.

Obs.: Mximo de 500kbytes, Formatos aceitos: JPG, GIF, PNG, BMP.
Sua logomarca poder ser reduzida para as propores mximas de
150 x 55 pixels.

URL de notificao
Digite a URL em que voc receber as notificaes feitas em sua
aplicao.

URL de redirecionamento
Digite a URL que o usurio ir ser levado aps a finalizao do
pagamento.

Tambm possvel habilitar o redirecionamento com o cdigo de transao. Com a opo
habilitada, o PagSeguro ir enviar como parmetro, via GET, o cdigo de transao que foi
gerado. Sua aplicao poder utilizar esse cdigo para exibir informaes da transao ao
comprador.

Caso habilite esta opo, voc poder escolher o nome do parmetro GET que ser utilizado
conforme a Imagem 2

Imagem 2


VERSO 1.0.2
Aps criar a sua aplicao ser apresentado um resumo com os dados da aplicao, inclusive a
chave (appKey) da sua aplicao como apresentado na Imagem 3.

Imagem 3

Ateno: Guarde bem a sua chave de aplicao, pois ela essencial para que voc
possa efetuar as iteraes com as APIs de Pagamento e Assinatura e no ser
apresentada em nenhum outro momento.

Aps guardar bem a sua chave da aplicao, voc pode clicar em Ir para Minhas Aplicaes
para visualizar a listagem de aplicaes. A listagem apresentada conforme a Imagem 4.


VERSO 1.0.2
Imagem 4
Voc pode editar as informaes da sua aplicao, inclusive gerar uma nova chave a qualquer
momento clicando em Editar aplicao.
De todos os campos, s no possvel alterar o ID da aplicao.

Tambm possvel excluir uma aplicao. Ao excluir uma aplicao, todas as permisses
concedidas a ela so perdidas, ou seja:

Ela no poder mais criar checkouts
Ela no poder mais receber pagamentos a partir de checkouts criados antes da
remoo
Ela poder continuar recebendo notificaes
Ela no ser exibida mais na listagem de aplicaes do integrador
Ela no ser mais exibida na listagem de autorizaes concedidas

Autorizao

Aps criar uma aplicao voc poder pedir a autorizao do seu cliente para criar checkout,
criar assinaturas, efetuar consultas entre outras aes em.

O fluxo de autorizao exemplificado na Imagem 5:

Imagem 5


VERSO 1.0.2
Informando os dados da requisio
A requisio API de Autorizaes feita informando os dados de autorizao via XML
utilizando o mtodo POST.

Veja abaixo os cabealhos HTTP necessrios para fazer uma requisio API informando os
dados no formato XML.

URL da API de Assinatura do PagSeguro:
https://ws.pagseguro.uol.com.br/v2/authorizations/request

O cabealho Content-Type deve ser informado como no exemplo abaixo:
Content-Type: application/xml; charset=ISO-8859-1
Observao: caso sua aplicao ou loja no utilize o conjunto de caracteres ISO-8859-1,
p.e.(UTF-8), necessrio substituir o parmetro charset do exemplo acima.
Veja abaixo exemplo de XML estruturado para representar os dados de uma requisio:
1. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2. <authorizationRequest>
3. <reference>123</reference>
4. <permissions>
5. <code>CREATE_CHECKOUTS</code>
6. </permissions>
7. <redirectURL>http://todaoferta.uol.com.br</redirectURL>
8. </authorizationRequest>

Parmetros de autenticao
Os parmetros de autenticao so passados via query string

PARMETRO DESCRIO
appId
ID da Aplicao.

Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de at 60 caracteres.
appKey
Especifica o token correspondente aplicao PagSeguro que est
realizando a requisio.

Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.


VERSO 1.0.2

Parmetros de requisio
Os parmetros esperados pela API de Requisio so case sensitive e esto descritos na tabela
abaixo:

PARMETRO XML DESCRIO
<reference>
Identificador usado para fazer referncia autorizao da sua
requisio.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com limite total de 20 caracteres.
<permissions>
Permisses a serem autorizadas
Tipo: Texto.
Valores aceitos:

Valor Descrio
CREATE_CHECKOUTS
A aplicao poder
direcionar
compradores para o
PagSeguro e
intermediar
pagamentos para voc
RECEIVE_TRANSACTION_NOTIFICATIONS
A aplicao poder
receber e consultar
notificaes das
transaes que ela
intermediou para voc
SEARCH_TRANSACTIONS
A aplicao poder
consultar as
transaes que ela
MANAGE_PAYMENT_PRE_APPROVALS
A aplicao poder
gerenciar e utilizar
pr-aprovaes de
pagamentos para voc
<redirectURL>
URL para onde o comprador ser redirecionado aps a finalizao
do fluxo de autorizao.
Tipo: Texto.
Formato: Uma URL vlida, com limite de 255 caracteres.


VERSO 1.0.2
Dados do cliente e sugesto para cadastro
Quando o usurio redirecionado para autorizar ou rejeitar uma lista de permisses, ele tem a
possibilidade de se autenticar ou criar um cadastro (vendedor ou empresarial) novo.

A chamada para a requisio de autorizao permite que sejam informados os dados do
vendedor e assim, caso ele escolha cadastrar-se, todos os dados que foram enviados via API
sero sugeridos a ele no fluxo de cadastro.

Caso o e-mail do vendedor enviado via API j esteja cadastrado na base do PagSeguro, ser
sugerido o login com este e-mail

Ateno: Quantos mais dados corretos forem informados, maior a chance de
converso do vendedor no cadastrado nesse fluxo.

Veja abaixo exemplo de XML estruturado para representar os dados de uma autorizao com a
sugesto de uma conta Vendedor:
4. <permissions>
6. <code>SEARCH_TRANSACTIONS</code>
7. <code>RECEIVE_TRANSACTION_NOTIFICATIONS</code>
8. </permissions>
9. <redirectURL>http://www.seusite.com.br/retorno.php</redirectURL>
10. <account>
11. <email>usuario@pagseguro.com</email>
12. <type>SELLER</type>
13. <person>
14. <name>Coriolis Storm</name>
15. <documents>
16. <document>
17. <type>CPF</type>
18. <value>23606838450</value>
19. </document>
20. </documents>
21. <birthDate>1982-02-05</birthDate>
22. <phones>
23. <phone>
24. <type>HOME</type>
25. <areaCode>11</areaCode>
26. <number>30302323</number>
27. </phone>
28. <phone>
29. <type>MOBILE</type>
32. </phone>
33. </phones>
34. <address>
35. <postalCode>01452002</postalCode>
36. <street>Av. Brig. Faria Lima</street>

VERSO 1.0.2
38. <complement>5o andar</complement>
39. <district>Jardim Paulistano</district>
40. <city>Sao Paulo</city>
41. <state>SP</state>
42. <country>BRA</country>
43. </address>
44. </person>
45. </account>
Veja abaixo exemplo de XML estruturado para representar os dados de uma autorizao com a
sugesto de uma conta Empresarial:
4. <permissions>
6. </permissions>
7. <redirectURL> http://www.seusite.com.br/retorno.php</redirectURL>
8. <account>
9. <email>usuario@pagseguro.com.br</email>
10. <type>COMPANY</type>
11. <company>
12. <name>Coriolis Storm</name>
13. <documents>
14. <document>
15. <type>CNPJ</type>
16. <value>17302417000101</value>
17. </document>
18. </documents>
19. <displayName>Coriolis Storm</displayName>
20. <websiteURL>http://www.coriolis.com.br</websiteURL>
21. <partner>
22. <name>Joo Paulo Bruxelas</name>
23. <documents>
24. <document>
25. <type>CPF</type>
26. <value>34163749160</value>
27. </document>
28. </documents>
29. <birthDate>1982-02-05</birthDate>
30. </partner>
31. <phones>
32. <phone>
33. <type>BUSINESS</type>
36. </phone>
37. <phone>
38. <type>BUSINESS</type>
41. </phone>
42. </phones>
43. <address>
44. <postalCode>01452002</postalCode>

VERSO 1.0.2
45. <street>Av. Brig. Faria Lima</street>
47. <complement>5o andar</complement>
48. <district>Jardim Paulistano</district>
49. <city>Sao Paulo</city>
50. <state>SP</state>
51. <country>BRA</country>
52. </address>
53. </company>
54. </account>

Os parmetros abaixo ficam aninhados dentro da tag <authorizationRequest>.

<account>
Este campo a raiz do arquivo XML e engloba os dados do
cadastro.
Presena: Opcional.
<account>
<email>
Conta a ser cadastrada

Presena: Opcional.
Tipo: Texto.
Formato: um e-mail vlido (p.e., usuario@site.com.br), com no
mximo 60 caracteres.
<account>
<type>
Tipo da conta.

Presena: Opcional.
Tipo: Texto.
Formato: Os tipos de contas so: PERSONAL, SELLER ou COMPANY
<account>
<person>
Agrupa os dados de vendedor.
<account>
<seller>
<name>
Nome completo do vendedor

Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
<account>
<seller>
<documents>
Agrupa a informao de documento do vendedor.
<account>
<seller>
<documents>
<document>
Agrupa a informao de documento do vendedor.
Presena: Opcional (CPF).

VERSO 1.0.2
<account>
<seller>
<documents>
<document>
<type>
Tipo do documento

Presena: Obrigatria, se informada a tag document.
Tipo: Texto.
Formato: O tipo documento permitido para o vendedor somente
CPF
<account>
<seller>
<documents>
<document>
<type>
<value>
CPF do vendedor

Presena: Obrigatria, se informada a tag document.
Tipo: Nmero.
Formato: Aceitar apenas nmeros de CPF vlidos e no restritos
(no PagSeguro/UOL).
<account>
<seller>
<birthDate>
Data de nascimento do Vendedor

Presena: Opcional.
Tipo: Texto.
Formato: DD/MM/AAAA.
<account>
<seller>
<phones>
Agrupa as informaes de telefone do vendedor.
<account>
<seller>
<phones>
<phone>
Agrupa as informaes de telefone do vendedor.
Presena: Opcional.

<account>
<seller>
<phones>
<phone>
<type>
Tipo de telefone

Presena : Obrigatria, se informada a tag phone.
Tipo: Texto.
Formato: Os tipos de telefone permitidos so HOME, MOBILE e
BUSINESS.
<account>
<seller>
<phones>
<phone>
<areaCode>
Cdigo de rea do telefone

Presena: Obrigatria, se informada a tag phone.
Tipo: Nmero.
Formato: Um nmero de 2 dgitos correspondente a um DDD vlido.
<account>
<seller>
<phones>
<phone>
<number>
Nmero do telefone

Presena: Obrigatria, se informada a tag phone.
Tipo: Nmero.
Formato: Aceita apenas nmeros de 8 a 9 dgitos.
<account>
<company>
Agrupa os dados de empresa

VERSO 1.0.2
<account>
<company>
<displayName>
Nome completo da empresa

Presena: Opcional.
Tipo: Texto.
<account>
<company>
<documents>
Agrupa as informaes de documentos do responsvel legal pela
empresa e empresa
<account>
<company>
<documents>
<document>
Agrupa as informaes de documentos do responsvel legal pela
empresa e empresa
Presena: Opcional (CPF e CNPJ)
<account>
<company>
<documents>
<document>
<type>
CNPJ da empresa

Presena: Obrigatria se informada a tag document.
Tipo: Nmero.
Formato: Aceitar apenas nmeros de CNPJ vlidos e no restritos
(no PagSeguro/UOL).
<account>
<company>
<websiteURL>
URL do website da empresa

Presena: Opcional.
Tipo: Texto.
Formato: Uma URL vlida com no mximo 256 caracteres.
<account>
<company>
<partner>
Agrupa os dados do responsvel legal pela empresa.
<account>
<company>
<partner>
<name>
Nome do responsvel legal pela empresa

Presena: Opcional.
Tipo: Texto.
<account>
<seller>
<documents>
<document>
<type>
<value>
CPF do vendedor

Presena: Obrigatria se informada a tag document.
Tipo: Nmero.
Formato: Quando o type for CPF aceitar apenas nmero de CPF
vlido e no restrito (no PagSeguro/UOL).
<account>
<company>
<partner>
<birthDate>
Data de nascimento do Vendedor

Presena: Opcional.
Tipo: Texto.
Formato: DD/MM/AAAA.

VERSO 1.0.2
<account>
<address>
Agrupa os dados de endereo do vendedor ou empresa.

Presena: Opcional.
<account>
<address>
<postalCode>
CEP do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Nmero.
Formato: Um nmero de 8 dgitos correspondente a um CEP vlido.
<account>
<address>
<street>
Nome da rua do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Texto.
Formato: Texto com nmeros, letras (sem acento), espaos e os
caracteres . (ponto) e - hfen, com no mximo 80 caracteres.
O valor deste campo s ser cadastrado quando CEP informado no
tiver nome de rua associado.
<account>
<address>
<number>
Nmero do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Texto.
Formato: Texto livre com no mximo 20 caracteres.
<account>
<address>
<complement>
Complemento do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Texto.
<account>
<address>
<district>
Bairro do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Texto.
O valor deste campo s ser cadastrado quando CEP informado no
tiver bairro associado.
<account>
<address>
<city>
Cidade do endereo do vendedor ou da empresa.

Presena: Opcional.
Tipo: Texto.
Formato: Texto livre. Ser cadastrada a cidade associada ao CEP
informado.
<account>
Estado do endereo do vendedor ou da empresa.

VERSO 1.0.2
<address>
<state>

Presena: Opcional.
Tipo: Texto.
Formato: Texto livre. Ser cadastrado o estado associado ao CEP
informado.
<account>
<address>
<country>
Cdigo ISO do pas do endereo do vendedor ou da empresa

Presena: Opcional.
Tipo: Texto.
Formato: de 2 a 10 nmeros, letras e o caractere - (hfen).

Resposta da API de Autorizao
A resposta dada em formato XML. O exemplo abaixo mostra uma resposta de sucesso a uma
chamada API de autorizao:
2. <code>D8DD848AC9C98D9EE44C5FB3A1E53913</code>
3. <date>2011-02-25T11:40:50.000-03:00</date>
As tabelas abaixo descrevem os parmetros retornados.

PARMETRO DESCRIO
<authorizationRequest>
Raiz do arquivo XML de resposta. Contm os dados do cdigo de
autorizao criado.
<code>
Cdigo de redirecionamento criado. Este cdigo deve ser usado para
direcionar o comprador para o fluxo de autorizao.

Tipo: Texto.
<date>
Data da requisio.

Tipo: Data/Hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD.

Caso ocorra algum erro na chamada API de Autorizao uma resposta de erro ser retornada,
como no exemplo abaixo. Ela indicar todos os erros identificados na chamada:
1. <errors>
2. <error>
3. <code>11064</code>

VERSO 1.0.2
4. <message>redirectURL must have the same domain as application
URL.</message>
5. </error>
6. </errors>


VERSO 1.0.2
As tabelas abaixo descrevem os parmetros retornados.

PARMETRO DESCRIO
<errors> Lista de erros.
<errors>
<error>
Dados do erro encontrado.
<errors>
<error>
<code>
Cdigo do erro.
Tipo: Texto.
Formato: Ver Tabela de Erros na pgina 24.
< errors >
<error >
<message>
Mensagem descritiva.
Tipo: Texto.

Veja a tabela de erros na pgina 24.

Direcionando o comprador para o fluxo de
autorizao
Aps realizar uma chamada com sucesso API, voc deve direcionar o comprador para o fluxo
de autorizao, usando o cdigo de requisio retornado. O exemplo abaixo mostra uma URL
montada para que o usurio inicie um fluxo de autorizao.
https://pagseguro.uol.com.br/v2/authorization/request.jhtml?code={resquestCode}

A tabela abaixo descreve o parmetro utilizado

PARMETRO DESCRIO
Code
Cdigo de requisio retornado pela chamada API de autorizao
do PagSeguro

Presena: Obrigatria

Fluxo de autorizao
Ao realizar a chamada com sucesso API de autorizao e redirecionar o cliente ao PagSeguro,
ser exibido uma tela com base nas informaes que voc encaminhou na chamada.

Se voc no encaminhou nenhum dado do cliente ou encaminhou os dados e o PagSeguro
verificou que este cliente no possui uma conta no PagSeguro, ser apresentado uma tela com
destaque para a criao de uma conta e, logo abaixo, a opo de efetuar o login no PagSeguro,
conforme a Imagem 6 abaixo:

VERSO 1.0.2

Imagem 6

Se voc encaminhou os dados e o PagSeguro verificou que este cliente possui uma conta, ser
apresentado uma tela com destaque para o login com o e-mail enviado e a possibilidade, sem
muito destaque, de criao de uma nova conta no PagSeguro, conforme ilustra a Imagem 7
abaixo:

Imagem 7

VERSO 1.0.2

Ateno: Todos os dados enviados como sugesto podero ser alterados no fluxo de
cadastro. Portanto, no utilize esses dados como chave para vincular a conta
PagSeguro no seu sistema, nem mesmo o e-mail.

Aps ter criado a conta ou ter se autenticado, ser apresentado ao seu cliente uma tela
conforme a Imagem 8 abaixo:

Imagem 8

Revogao de autorizao
O seu cliente pode revogar a qualquer momento a autorizao concedida para a aplicao.
Para isso, ele deve acessar o link a seguir, selecionar a aplicao desejada e clicar em Remover
autorizao.

Link: https://pagseguro.uol.com.br/aplicacao/listarAutorizacoes.jhtml

Imagem 9


VERSO 1.0.2


VERSO 1.0.2
Pagamentos e Assinaturas

Aps obter a autorizao do vendedor, sua aplicao possui agora a possibilidade de utilizar as
APIs do PagSeguro, se autenticando com a aplicao, e no mais com os dados do vendedor.

Veja abaixo as APIs disponveis para utilizao pela sua aplicao:
Pagamentos
Criao de checkout
Consulta de notificao de checkout
Consulta de transao (por cdigo, intervalo de tempo)

Assinaturas
Criao de Assinatura
Criao de Checkout com assinatura associada
Consulta de notificao de assinatura
Consulta e Cobrana de assinatura
Cancelamento de Assinatura

Para utilizar as APIs do PagSeguro utilizando a autorizao concedida pelo cliente, basta que
voc substitua as credenciais email e token pelas credenciais appId, appKey e pelo
authorizationCode gerado pela aplicao. Veja o exemplo abaixo:

Exemplo de uma Consulta de notificao(as linhas foram quebradas para facilitar a leitura):

https://ws.pagseguro.uol.com.br/v2/transactions
/9E884542-81B3-4419-9A75-BCC6FB495EF1
?email=suporte@lojamodelo.com.br
&token=95112EE828D94278BD394E91C4388F20

Utilizando o modelo de aplicaes basta que voc passe, ao invs do e-mail e token do cliente,
o appId e appKey da sua aplicao e o authorizationCode conforme abaixo:

https://ws.pagseguro.uol.com.br/v2/transactions
/9E884542-81B3-4419-9A75-BCC6FB495EF1
?appId=lojamodelo1
&appKey=DEF1AF34D4D45C02240DCFAFBDD066F4
&authorizationCode=9D7FF2E921216F1334EE9FBEB7B4EBBC

Ateno: A API de notificaes no necessita do parmetro authorizationCode para a
autenticao.


VERSO 1.0.2
Notificaes

Aps o comprador autorizar a aplicao, o PagSeguro enviar uma notificao ao seu sistema
com o status da autorizao.

A Imagem 7 ilustra o funcionamento da notificao. Note que o PagSeguro que inicia o
processo de notificao ao enviar um cdigo para seu sistema.

Imagem 10

Configurando o recebimento de notificaes
Para utilizar a API de Notificaes voc deve primeiramente ter criado uma aplicao. O
endereo (URL) de notificao configurado no momento da criao da aplicao (Pgina 5).
A visualizao ou alterao desta URL em uma aplicao j existente pode ser feito atravs
da pgina de listagem de aplicaes no endereo
https://pagseguro.uol.com.br/aplicacao/listagem.jhtml, clicando no boto Editar aplicao.

Recebendo uma notificao de transao
Uma vez configurado o endereo para onde o PagSeguro ir enviar notificaes, o prximo
passo preparar seu sistema para receber o cdigo de notificao.
O PagSeguro envia as notificaes para a URL que voc configurou usando o protocolo HTTP,
pelo mtodo POST.

Veja abaixo um exemplo de notificao enviada pelo PagSeguro (as linhas foram quebradas
para facilitar a leitura):

POST http://lojamodelo.com.br/notificacao HTTP/1.1

VERSO 1.0.2
Host:pagseguro.uol.com.br
Content-Length:85
Content-Type:application/x-www-form-urlencoded
notificationCode=766B9C-AD4B044B04DA-77742F5FA653-E1AB24
&notificationType=applicationAuthorization

PARMETRO DESCRIO
notificationCode
O cdigo que identifica a notificao. Este cdigo deve ser usado
para consultar a notificao e obter os dados da
transao/assinatura associada. Note que o cdigo que identifica a
notificao no o mesmo que o cdigo que identifica a transao.

Tipo: Texto.
notificationType
O tipo da notificao enviada.

Tipo: Texto.
Formato: Para notificaes de autorizao ser
applicationAuthorization

Note que a notificao no possui nenhuma informao sobre a autorizao. Portanto, assim
que seu sistema recebe uma notificao, ele deve consulta-la para obter os dados, como
descrito adiante.

Lembre-se que, enquanto seu sistema no consultar uma notificao enviada, o PagSeguro ir
envia-la novamente a cada 2 horas, at um mximo de 5 tentativas. Se seu sistema ficou
indisponvel por um perodo maior que este e no recebeu nenhum dos envios da notificao,
ainda assim possvel obter os dados de suas autorizaes usando a Consulta de Autorizaes.


VERSO 1.0.2
Consultas
O PagSeguro conta com uma API de Consultas para que voc possa obter os dados de suas
autorizaes de forma fcil, rpida e segura.
Para consultar dados de uma autorizao a loja deve fazer uma requisio informando, alm
do appId e appKey, os dados necessrios para a consulta escolhida, como por exemplo, o
cdigo de notificao. O mtodo usado deve ser o HTTP GET.

Consultando uma autorizao pelo cdigo de
notificao
Esta consulta deve ser utilizada para consultar uma notificao recebida a fim de obter os
dados da autorizao.

URL utilizada para efetuar a consulta:
https://ws.pagseguro.uol.com.br/v2/authorizations/notifications/{notificationCode}?ap
pId={appId}&appKey={appKey}}


PARMETRO DESCRIO
appId
ID da Aplicao.

Tipo: Texto.
appKey

Tipo: Texto.


PARMETRO DESCRIO
notificationCode (aps notifications/)
Cdigo identificador da notificao.

Informa o cdigo da notificao que voc quer consultar. O cdigo
deve ser informado no caminho da URL. Voc deve usar o cdigo
que recebeu pelo parmetro notificationCode no envio da
notificao.
Tipo: Texto.

VERSO 1.0.2
Consultando uma autorizao pelo seu cdigo
Esta consulta possibilita o acesso a todos os dados de uma autorizao a partir de seu cdigo
identificador.

https://ws.pagseguro.uol.com.br/v2/authorizations/{authorizationCode}?appId={appId}&a
ppKey={appKey}


PARMETRO DESCRIO
appId
ID da Aplicao.

Tipo: Texto.
appKey

Tipo: Texto.


PARMETRO DESCRIO
authorizationCode (aps
authorizations /)
Cdigo que identifica a autorizao a ser consultada/cancelada.
Presena: Obrigatria na consulta de uma autorizao.
Tipo: Texto.


VERSO 1.0.2
Para ambas as consultas acima, a resposta dada em formato XML, como no exemplo abaixo.
1. <authorization>
2. <code>9D7FF2E921216F1334EE9FBEB7B4EBBC</code>
3. <creationDate>2011-03-30T14:20:13.000-03:00</creationDate>
4. <reference>ref1234</reference>
5. <permissions>
6. <permission>
8. <status>APPROVED</status>
9. <lastUpdate>2011-03-30T15:35:44.000-03:00</lastUpdate>
10. </permission>
11. <permission>
15. </permission>
16. </permissions>
17. </authorization>

As tabelas abaixo descrevem os parmetros retornados pelas consultas.

PARMETRO DESCRIO
<authorization> Raiz do arquivo XML de resposta. Contm os dados da autorizao.
<authorization>
<code>

Cdigo de autorizao.
Tipo: Texto.
<authorization>
<creationDate>

Data da criao da autorizao
Tipo: Texto.
<authorization>
<reference>
Identificador que foi usado para fazer referncia autorizao no momento
de sua requisio.
Tipo: Data/Hora.
<authorization>
<permissions>

Representa as permisses retornadas pela autorizao.
Tipo: Texto.
<authorization>
<permissions>
<permission>

Dados de uma permisso retornada pela consulta.
Tipo: Texto.

VERSO 1.0.2
PARMETRO DESCRIO
<authorization>
<permissions>
<permission>
<code>
Cdigo da permisso.
Tipo: Texto.
Valor Descrio
CREATE_CHECKOUTS
A aplicao poder direcionar
compradores para o PagSeguro
e intermediar pagamentos para
voc
A aplicao poder receber e
consultar notificaes das
transaes que ela intermediou
para voc
SEARCH_TRANSACTIONS
A aplicao poder consultar as
transaes que ela intermediou
para voc
A aplicao poder gerenciar e
utilizar pr-aprovaes de
pagamentos para voc
<authorization>
<permissions>
<permission>
<status>
Status da permisso do cliente.
Tipo: Texto.
Valor Descrio
PENDING
Pendente de aprovao
APPROVED
Aprovado pelo cliente
DENIED
Negado pelo cliente
<authorization>
<permissions>
<permission>
<lastUpdate>
Data/hora em que ocorreu a ltima alterao no status da permisso.
Tipo: Texto.

Tambm possvel efetuar atravs da API de Consultas, uma consulta trazendo todas as
autorizaes cedidas para a aplicao.

Consultando todas as autorizaes da aplicao
(beta)
Permite o acesso aos dados de todas as autorizaes cedidas para a aplicao.

https://ws.pagseguro.uol.com.br/v2/authorizations?appId={appId}&appKey={appKe}


VERSO 1.0.2

O resultado apresentado em XML conforme o exemplo abaixo:
1. <authorizationSearchResult>
2. <date>2011-03-30T11:09:11.000-03:00</date>
3. <authorizations>
4. <authorization>
5. <code>5A220D39B3B31E8BB4E3EFA4FCC4E6A3</code>
6. <creationDate>2011-03-21T16:32:21.000-03:00</creationDate>
8. <permissions>
9. <permission>
13. </permission>
14. <permission>
15. <code>RECEIVE_TRANSACTION_NOTIFICATIONS</code>
18. </permission>
19. <permission>
23. </permission>
24. </permissions>
25. </authorization>
26. </authorizations>
27. </authorizationSearchResult>
As tabelas abaixo descrevem os parmetros retornados pelas consultas.
PARMETRO DESCRIO
<authorizationSearchResult>
Raiz do arquivo XML de resposta. Contm os dados da consulta de
autorizaes.
<date> Informa a data/hora em que a consulta foi realizada.
<authorizations>
<authorization>
Contm os dados da autorizao.
<authorizations>
<authorization>
Cdigo de autorizao.
Tipo: Texto.

VERSO 1.0.2
PARMETRO DESCRIO
<code>
<authorizations>
<authorization>
<creationDate>

Data da criao da autorizao
Tipo: Texto.
<authorizations>
<authorization>
<reference>

Identificador que foi usado para fazer referncia autorizao no
momento de sua requisio.
Tipo: Data/Hora.
<authorizations>
<authorization>
<permissions>

Representa as permisses retornadas pela autorizao.
Tipo: Texto.
<authorizations>
<authorization>
<permissions>
<permission>

Dados de uma permisso retornada pela consulta.
Tipo: Texto.
<authorizations>
<authorization>
<permissions>
<permission>
<code>
Cdigo da permisso.
Tipo: Texto.

Valor Descrio
CREATE_CHECKOUTS
A aplicao poder
direcionar
compradores para o
PagSeguro e
intermediar
pagamentos para voc
A aplicao poder
receber e consultar
notificaes das
transaes que ela
SEARCH_TRANSACTIONS
A aplicao poder
consultar as
transaes que ela
A aplicao poder
gerenciar e utilizar
pr-aprovaes de

VERSO 1.0.2
PARMETRO DESCRIO
pagamentos para voc
<authorizations>
<authorization>
<permissions>
<permission>
<status>
Status da permisso do cliente.
Tipo: Texto.
Valor Descrio
PENDING
Pendente de aprovao
APPROVED
Aprovado pelo cliente
DENIED
Negado pelo cliente
<authorizations>
<authorization>
<permissions>
<permission>
<lastUpdate>
Data/hora em que ocorreu a ltima alterao no status da
permisso.
Tipo: Texto.

Caso ocorra algum erro na chamada API de Consultas, seja algum erro nos parmetros
informados ou alguma falha tcnica 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>13014</code>
4. <message>maxPageResults invalid value (must be between 1 and
1000).</message>
5. </error>
6. </errors>
Abaixo so descritos os campos do XML de resposta da consulta a uma notificao de
transao.

PARMETRO DESCRIO
<errors> Lista de erros.
<errors>
<error>
Dados do erro encontrado.
<errors>
<error>
<code>
Cdigo do erro.

Tipo: Texto.
<errors>
<error>
<message>
Mensagem descritiva.

Tipo: Texto.

VERSO 1.0.2
PARMETRO DESCRIO

Tabela de Erros
Veja abaixo a tabela de erros:

CDIGO DO ERRO DESCRIO
12001 appId is required.
12002 appKey is required.
12003 permissions is required.
12004 redirectURL is required.
12005 appId invalid length: {0}
12006 appKey invalid length: {0}
12007 reference invalid length: {0}
12008 permissions invalid length: {0}
12009 redirectURL must have the same domain as application URL.
12010 permissions invalid: {0}
12011 inactive application: {0}
12012 redirectURL invalid length: {0}
12013 redirectURL invalid value: {0}
50110 Date must be like yyyy-MM-dd
50128 The telephone does not respect the 8 or 9 digit pattern
50129 The telephone area code must have 2 digits
50130 The postal code must have 8 digits
50132 The CPF must have 11 digits
50133 The CNPJ must have 14 digits
50134 Seller must be over 18 years old

VERSO 1.0.2
CDIGO DO ERRO DESCRIO
50135 Partner must be over 18 years old
50136 Invalid e-mail
50137 Invalid user type
50140 Email too big. Maximum = 60 characters
50141 Name too big. Maximum = 50 characters
50142 Address too big. Maximum = 80 characters
50143 Address Number too big. Maximum = 20 characters
50144 Address Complement too big. Maximum = 40 characters
50145 Address District too big. Maximum = 60 characters
50146 Company Name too big. Maximum = 50 characters
50147 Display Name too big. Maximum = 50 characters
50148 Website URL too big. Maximum = 256 characters

Modelo Aplicacoes PT BR v2

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Modelo Aplicacoes PT BR v2

Enviado por

Direitos autorais:

Formatos disponíveis

GUIA DE INTEGRAO ASSINATURA 1

Você também pode gostar