Académique Documents
Professionnel Documents
Culture Documents
Modelo de Aplicaes
MODELO DE APLICAES
Histrico de Verses
DATA
26/02/2013
13/03/2013
03/05/2013
24/01/2014
11/03/2014
28/08/2014
05/01/2015
14/10/2015
DESCRIO
Viso Geral
Reviso
Adio de sugesto de criao de conta
Reviso
Incluso do parmetro DIRECT_PAYMENT
Reviso
Reviso da consulta de autorizaes por data
Incluso da publicKey
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.4
MODELO DE APLICAES
Documentaes
Acessando a rea de documentaes do PagSeguro voc tem acesso a todas as APIs
disponveis pelo PagSeguro.
Acesse: https://pagseguro.uol.com.br/v2/guia-de-integracao/visao-geral.html
Sandbox
Teste sua integrao de pagamento sem alterar as transaes reais.
Acesse: https://sandbox.pagseguro.uol.com.br/
Frum
Participe da comunidade PagSeguro postando suas dvidas e auxiliando outros
desenvolvedores em nosso frum. Nossa equipe est sempre presente para lhe
auxiliar.
Acesse: http://forum.pagseguro.uol.com.br/
Mdulos
Desenvolvemos mdulos para que voc possa integrar o PagSeguro em diversas
plataformas de e-commerce com ainda mais facilidade.
Acesse: https://pagseguro.uol.com.br/v2/guia-de-integracao/downloads.html
Bibliotecas
Disponibilizamos bibliotecas em vrias linguagens e tutoriais para que voc possa
integrar o PagSeguro com em sua loja virtual, site ou blog.
Acesse: https://pagseguro.uol.com.br/v2/guia-de-integracao/downloads.html
VERSO 1.0.4
MODELO DE APLICAES
ndice
Histrico de Verses ...................................................................................................................... 2
Copyright ....................................................................................................................................... 2
Aviso Legal ..................................................................................................................................... 2
ndice ............................................................................................................................................. 4
Viso Geral..................................................................................................................................... 6
Etapas da Integrao ..................................................................................................................... 6
Aplicaes ...................................................................................................................................... 7
Autorizao.................................................................................................................................. 10
Informando os dados da requisio ................................................................................... 11
Parmetros de autenticao............................................................................................... 11
Parmetros de requisio ................................................................................................... 12
Dados do cliente e sugesto para cadastro ........................................................................ 13
Parmetros de requisio ................................................................................................... 15
Resposta da API de Autorizao ......................................................................................... 20
Direcionando o comprador para o fluxo de autorizao .................................................... 21
Fluxo de autorizao ........................................................................................................... 21
Notificaes ................................................................................................................................. 23
Configurando o recebimento de notificaes .................................................................... 24
Recebendo uma notificao de autorizao ...................................................................... 24
Consultas ..................................................................................................................................... 25
Consultando uma autorizao pelo cdigo de notificao ................................................ 25
Parmetros de autenticao............................................................................................... 26
Parmetros de requisio ................................................................................................... 26
Consultando uma autorizao pelo seu cdigo .................................................................. 26
Parmetros de autenticao............................................................................................... 27
Parmetros de requisio ................................................................................................... 27
VERSO 1.0.4
MODELO DE APLICAES
VERSO 1.0.4
MODELO DE APLICAES
Viso Geral
O modelo de aplicaes do PagSeguro permite que sua aplicao crie checkouts, receba notificaes de
pagamento entre outras funes em nome do cliente sem a necessidade de configurar tokens, URL de
retorno e outras informaes em sua conta PagSeguro.
Assim, o seu cliente pode se cadastrar em sua plataforma, autoriza-la e comear a vender sem a necessidade
de inserir informaes ou entrar na conta PagSeguro para efetuar configuraes.
O modelo de aplicaes do PagSeguro est disponvel para contas do tipo Vendedor e Empresarial.
Etapas da Integrao
A integrao possui algumas etapas bsicas:
1. Aplicaes
2. Autorizaes
3. Notificaes
4. Consulta
VERSO 1.0.4
MODELO DE APLICAES
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.
Ateno: Como o modelo de aplicaes uma ferramenta liberada apenas para alguns
parceiros, o acesso a esta feito atravs de algumas URLs diretas que voc ver no
decorrer da documentao.
Para criar uma nova aplicao, acesse o link https://pagseguro.uol.com.br/aplicacao/listagem.jhtml e clique
em criar suas aplicaes conforme apresentado na Imagem 1:
Imagem 1
Nome da aplicao
DESCRIO
Esse nome ir aparecer para voc e para os outros clientes que
usaro sua aplicao.
VERSO 1.0.4
MODELO DE APLICAES
PARMETRO
Descrio da aplicao
URL da aplicao
DESCRIO
Escreva a descrio que ir aparecer para os usurios em sua
aplicao. Procure ser objetivo e explicar resumidamente a sua
funo.
URL de notificao
URL de redirecionamento
Tambm possvel habilitar o redirecionamento com o cdigo de transao. Com a opo habilitada, o
PagSeguro ir enviar como parmetro, via GET, o cdigo da autorizao que foi gerado. Sua aplicao poder
utilizar esse cdigo para exibir informaes da autorizao ao cliente.
Caso habilite esta opo, voc poder escolher o nome do parmetro GET que ser utilizado conforme a
Imagem 2.
Imagem 2
VERSO 1.0.4
MODELO DE APLICAES
Aps criar a sua aplicao ser apresentado um resumo com os dados da aplicao, inclusive a chave da sua
aplicao (ou appKey) 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.
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.
Imagem 4
VERSO 1.0.4
10
MODELO DE APLICAES
Voc pode editar as informaes da sua aplicao, inclusive gerar uma nova appKey a qualquer momento
clicando em Editar aplicao > Gerar nova chave. Com exceo do ID da aplicao, todos os campos da
aplicao so editveis.
Tambm possvel excluir uma aplicao. Ao excluir uma aplicao, todas as permisses concedidas a ela
so perdidas, ou seja:
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.4
11
MODELO DE APLICAES
Parmetros de autenticao
PARMETRO
DESCRIO
appId
ID da Aplicao.
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de at 60 caracteres.
appKey
Veja abaixo os cabealhos HTTP necessrios para fazer uma requisio API de autorizao do PagSeguro
informando os dados no formato XML.
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.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
VERSO 1.0.4
12
MODELO DE APLICAES
Parmetros de requisio
Os parmetros esperados pela API de Requisio so Case sensitive e esto descritos na tabela abaixo:
PARMETRO XML
<reference>
DESCRIO
Identificador usado para fazer referncia autorizao da sua requisio.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com limite total de 20 caracteres.
Permisses a serem autorizadas
Presena: Obrigatria.
Tipo: Texto.
Valores aceitos:
VALOR
DESCRIO
A aplicao poder direcionar
compradores para o PagSeguro
e intermediar pagamentos
RECEIVE_TRANSACTION_NOTIFICATIONS A aplicao poder receber e
consultar notificaes das
transaes que ela intermediou
SEARCH_TRANSACTIONS
A aplicao poder consultar as
transaes que ela intermediou
MANAGE_PAYMENT_PRE_APPROVALS
A aplicao poder gerenciar e
utilizar pr-aprovaes de
pagamentos
DIRECT_PAYMENT
A aplicao poder gerenciar
pagamentos via checkout
transparente.
Ateno: necessrio liberao
atravs da rea comercial do
PagSeguro
CREATE_CHECKOUTS
<permissions>
<redirectURL>
<notificationURL>
VERSO 1.0.4
13
MODELO DE APLICAES
<reference>123</reference>
4.
<permissions>
5.
<code>CREATE_CHECKOUTS</code>
6.
<code>SEARCH_TRANSACTIONS</code>
7.
<code>RECEIVE_TRANSACTION_NOTIFICATIONS</code>
8.
</permissions>
9.
<redirectURL>http://seusite.com.br/redirect</redirectURL>
10.
<notificationURL>http://seusite.com.br/notification</notificationURL>
11.
<account>
12.
<email>usuario@seusite.com.br</email>
13.
<type>SELLER</type>
14.
<person>
15.
<name>Antonio Carlos</name>
16.
<documents>
17.
<document>
18.
<type>CPF</type>
19.
<value>23606838450</value>
20.
</document>
21.
</documents>
22.
<birthDate>1982-02-05</birthDate>
23.
<phones>
24.
<phone>
25.
<type>HOME</type>
26.
<areaCode>11</areaCode>
27.
<number>30302323</number>
28.
</phone>
29.
<phone>
VERSO 1.0.4
14
MODELO DE APLICAES
30.
<type>MOBILE</type>
31.
<areaCode>11</areaCode>
32.
<number>976302323</number>
33.
</phone>
34.
</phones>
35.
<address>
36.
<postalCode>01452002</postalCode>
37.
38.
<number>1384</number>
39.
<complement>5o andar</complement>
40.
<district>Jardim Paulistano</district>
41.
<city>Sao Paulo</city>
42.
<state>SP</state>
43.
<country>BRA</country>
44.
</address>
45.
46.
</person>
</account>
47. </authorizationRequest>
Veja abaixo exemplo de XML estruturado para representar os dados de uma autorizao com a sugesto de
uma conta Empresarial:
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://seusite.com.br/redirect</redirectURL>
8.
<notificationURL>http://seusite.com.br/notification</notificationURL>
9.
<account>
10.
<email>usuario@seusite.com.br</email>
11.
<type>COMPANY</type>
12.
<company>
13.
14.
15.
<name>Seu Site</name>
<documents>
<document>
16.
<type>CNPJ</type>
17.
<value>17302417000101</value>
18.
19.
</document>
</documents>
20.
<displayName>Seu Site</displayName>
21.
<websiteURL>http://www.seusite.com.br</websiteURL>
22.
<partner>
23.
VERSO 1.0.4
<name>Antonio Carlos</name>
15
MODELO DE APLICAES
24.
<documents>
25.
<document>
26.
<type>CPF</type>
27.
<value>34163749160</value>
28.
</document>
29.
</documents>
30.
<birthDate>1982-02-05</birthDate>
31.
</partner>
32.
<phones>
33.
<phone>
34.
<type>BUSINESS</type>
35.
<areaCode>11</areaCode>
36.
<number>30302323</number>
37.
</phone>
38.
<phone>
39.
<type>BUSINESS</type>
40.
<areaCode>11</areaCode>
41.
<number>976302323</number>
42.
</phone>
43.
</phones>
44.
<address>
45.
<postalCode>01452002</postalCode>
46.
47.
<number>1384</number>
48.
<complement>5o andar</complement>
49.
<district>Jardim Paulistano</district>
50.
<city>Sao Paulo</city>
51.
<state>SP</state>
52.
<country>BRA</country>
53.
</address>
54.
</company>
55.
</account>
56. </authorizationRequest>
Parmetros de requisio
Os parmetros abaixo ficam aninhados dentro da tag <authorizationRequest>.
PARMETRO XML
DESCRIO
<account>
<account>
<email>
VERSO 1.0.4
16
MODELO DE APLICAES
PARMETRO XML
DESCRIO
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>
<account>
<seller>
<name>
<account>
<seller>
<documents>
<account>
<seller>
<documents>
<document>
<account>
<seller>
<documents>
<document>
<type>
Tipo do documento
<account>
<seller>
<documents>
<document>
<type>
<value>
CPF do vendedor
<account>
<seller>
<birthDate>
VERSO 1.0.4
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
Presena: Opcional.
Tipo: Texto.
Formato: DD/MM/AAAA.
17
MODELO DE APLICAES
PARMETRO XML
DESCRIO
<account>
<seller>
<phones>
<account>
<seller>
<phones>
<phone>
Tipo de telefone
<account>
<seller>
<phones>
<phone>
<type>
<account>
<seller>
<phones>
<phone>
<areaCode>
<account>
<seller>
<phones>
<phone>
<number>
Nmero do telefone
<account>
<company>
<account>
<company>
<displayName>
<account>
<company>
<documents>
<account>
<company>
<documents>
<document>
VERSO 1.0.4
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
18
MODELO DE APLICAES
PARMETRO XML
DESCRIO
<account>
<company>
<documents>
<document>
<type>
CNPJ da empresa
<account>
<company>
<websiteURL>
<account>
<company>
<partner>
<account>
<company>
<partner>
<name>
<account>
<seller>
<documents>
<document>
<type>
<value>
CPF do vendedor
<account>
<company>
<partner>
<birthDate>
<account>
<address>
Presena: Opcional.
Tipo: Texto.
Formato: Uma URL vlida com no mximo 256 caracteres.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 50 caracteres.
Presena: Opcional.
Tipo: Texto.
Formato: DD/MM/AAAA.
Presena: Opcional.
<account>
<address>
<postalCode>
VERSO 1.0.4
19
MODELO DE APLICAES
PARMETRO XML
DESCRIO
<account>
<address>
<street>
<account>
<address>
<number>
<account>
<address>
<complement>
<account>
<address>
<district>
<account>
<address>
<city>
<account>
<address>
<state>
VERSO 1.0.4
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.
Presena: Opcional.
Tipo: Texto.
Formato: Texto livre com no mximo 20 caracteres.
Presena: Opcional.
Tipo: Texto.
Formato: Texto com nmeros, letras (sem acento), espaos e os
caracteres . (ponto) e - hfen, com no mximo 40 caracteres.
Presena: Opcional.
Tipo: Texto.
Formato: Texto com nmeros, letras (sem acento), espaos e os
caracteres . (ponto) e - hfen, com no mximo 60 caracteres.
O valor deste campo s ser cadastrado quando CEP informado no
tiver bairro associado.
Presena: Opcional.
Tipo: Texto.
Formato: Texto livre. Ser cadastrada a cidade associada ao CEP
informado.
Presena: Opcional.
Tipo: Texto.
Formato: Texto livre. Ser cadastrado o estado associado ao CEP
informado.
20
MODELO DE APLICAES
PARMETRO XML
<account>
<address>
<country>
DESCRIO
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).
<code>D8DD848AC9C98D9EE44C5FB3A1E53913</code>
3.
<date>2011-02-25T11:40:50.000-03:00</date>
4. </authorizationRequest>
<authorizationRequest>
<code>
DESCRIO
Raiz do arquivo XML de resposta. Contm os dados do cdigo de
autorizao criado.
Cdigo de redirecionamento criado. Este cdigo deve ser usado para
direcionar o comprador para o fluxo de autorizao.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
Data da requisio.
<authorizationRequest>
<date>
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>
4.
5.
</error>
6. </errors>
VERSO 1.0.4
21
MODELO DE APLICAES
DESCRIO
<errors>
Lista de erros.
<errors>
<error>
<errors>
<error>
<code>
Cdigo do erro.
Tipo: Texto.
Formato: Ver Tabela de Erros na pgina 34.
Mensagem descritiva.
Tipo: Texto.
Formato: Ver Tabela de Erros na pgina 34.
Code
DESCRIO
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 propondo a criao de uma conta
primariamente e abaixo a opo de efetuar o login no PagSeguro conforme a Imagem 6 abaixo:
VERSO 1.0.4
22
MODELO DE APLICAES
Imagem 6
Se voc encaminhou os dados e o PagSeguro verificou que este cliente possui uma conta no PagSeguro, ser
apresentado os campos para que ele possa efetuar o login no PagSeguro primariamente e abaixo a opo
propondo a criao de uma conta conforme a Imagem 7 abaixo:
Imagem 7
VERSO 1.0.4
23
MODELO DE APLICAES
Aps ter criado a conta ou ter entrado com sua senha, ser apresentado uma tela informando ao cliente que
a sua aplicao deseja ter acesso s permisses enviadas na chamada de autorizao. apresentada
tambm ao cliente a explicao de cada uma das permisses e a opo de autorizar ou no a aplicao
conforme a Imagem 8 abaixo:
Imagem 8
Aps a deciso do cliente, clicando em Autorizar ou No autorizar, ele ser redirecionado para a sua URL de
retorno. Neste retorno o PagSeguro encaminha via GET o cdigo de notificao da autorizao para que
voc possa consultar na hora o resultado desta autorizao.
O retorno ser feito como o exemplo a seguir:
GET http://www.seusite.com.br/retorno?notificationCode={notificationCode}
Alm disso, o PagSeguro envia uma notificao para o seu site via POST.
Notificaes
Aps o comprador autorizar a aplicao, o PagSeguro enviar via POST uma notificao ao seu sistema com
o status da autorizao.
A Imagem 9 ilustra o funcionamento da notificao. Note que o PagSeguro que inicia o processo de
notificao ao enviar um cdigo para seu sistema.
VERSO 1.0.4
24
MODELO DE APLICAES
Imagem 9
VERSO 1.0.4
25
MODELO DE APLICAES
PARMETRO
notificationCode
DESCRIO
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.
Formato: Uma sequncia de 39 caracteres.
O tipo da notificao enviada.
notificationType
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.
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.
Veja abaixo como efetuar uma consulta:
VERSO 1.0.4
26
MODELO DE APLICAES
Parmetros de autenticao
PARMETRO
DESCRIO
ID da Aplicao.
appId
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de at 60 caracteres.
Especifica o token correspondente aplicao PagSeguro que est
realizando a requisio.
appKey
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
Parmetros de requisio
PARMETRO
DESCRIO
Cdigo identificador da notificao.
VERSO 1.0.4
27
MODELO DE APLICAES
Parmetros de autenticao
PARMETRO
DESCRIO
ID da Aplicao.
appId
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de at 60 caracteres.
Especifica o token correspondente aplicao PagSeguro que est
realizando a requisio.
appKey
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
Parmetros de requisio
PARMETRO
authorizationCode (aps
authorizations /)
DESCRIO
Cdigo que identifica a autorizao a ser consultada/cancelada.
Presena: Obrigatria na consulta de uma autorizao.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
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.
<account>
6.
<publicKey>PUB9B3227C6228848ACBFFCF46DD04C3211</publicKey>
7.
</account>
8.
<permissions>
9.
<permission>
10.
<code>CREATE_CHECKOUTS</code>
11.
<status>APPROVED</status>
12.
<lastUpdate>2011-03-30T15:35:44.000-03:00</lastUpdate>
13.
</permission>
14.
<permission>
15.
<code>SEARCH_TRANSACTIONS</code>
16.
<status>APPROVED</status>
17.
<lastUpdate>2011-03-30T14:20:13.000-03:00</lastUpdate>
18.
</permission>
19.
</permissions>
20. </authorization>
VERSO 1.0.4
28
MODELO DE APLICAES
DESCRIO
Raiz do arquivo XML de resposta. Contm os dados da autorizao.
<authorization>
<code>
Cdigo de autorizao.
Tipo: Texto.
<authorization>
<creationDate>
<authorization>
<reference>
<authorization>
<account>
<publicKey>
<authorization>
<permissions>
<authorization>
<permissions>
<permission>
Cdigo da permisso.
Tipo: Texto.
Valor
Descrio
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 intermediou
para voc
MANAGE_PAYMENT_PRE_APPROVALS
A aplicao poder gerenciar e
utilizar pr-aprovaes de
pagamentos para voc
CREATE_CHECKOUTS
<authorization>
<permissions>
<permission>
<code>
VERSO 1.0.4
29
MODELO DE APLICAES
PARMETRO
DESCRIO
Status da permisso do cliente.
Tipo: Texto.
<authorization>
<permissions>
<permission>
<status>
Valor
PENDING
APPROVED
DENIED
<authorization>
<permissions>
<permission>
<lastUpdate>
Descrio
Pendente de aprovao
Aprovado pelo cliente
Negado pelo cliente
<date>2014-11-02T11:09:11.000-03:00</date>
3.
<authorizations>
4.
<authorization>
5.
<code>5A220D39B3B31E8BB4E3EFA4FCC4E6A3</code>
6.
<creationDate>2014-11-01T16:32:21.000-03:00</creationDate>
7.
<reference>123</reference>
8.
9.
10.
11.
<account>
<publicKey>PUB9B3227C6228848ACBFFCF46DD04C3211</publicKey>
</account>
<permissions>
12.
<permission>
13.
<code>SEARCH_TRANSACTIONS</code>
14.
<status>APPROVED</status>
15.
<lastUpdate>2014-11-01T16:35:27.000-03:00</lastUpdate>
16.
</permission>
17.
<permission>
18.
<code>RECEIVE_TRANSACTION_NOTIFICATIONS</code>
19.
<status>APPROVED</status>
20.
<lastUpdate>2014-11-01T16:35:27.000-03:00</lastUpdate>
VERSO 1.0.4
30
MODELO DE APLICAES
21.
</permission>
22.
<permission>
23.
<code>CREATE_CHECKOUTS</code>
24.
<status>APPROVED</status>
25.
<lastUpdate>2014-11-01T16:35:27.000-03:00</lastUpdate>
26.
</permission>
27.
</permissions>
28.
29.
</authorization>
</authorizations>
30. </authorizationSearchResult>
DESCRIO
<authorizationSearchResult>
<date>
<authorizationSearchResult>
<authorizations>
<authorization>
<authorizationSearchResult>
<authorizations>
<authorization>
<code>
Cdigo de autorizao.
Tipo: Texto.
<authorizationSearchResult>
<authorizations>
<authorization>
<creationDate>
<authorizationSearchResult>
<authorizations>
<authorization>
<reference>
<authorizationSearchResult>
<authorizations>
<authorization>
<reference>
<account> <publicKey>
<authorizationSearchResult>
<authorizations>
<authorization>
<permissions>
VERSO 1.0.4
31
MODELO DE APLICAES
PARMETRO
<authorizationSearchResult>
<authorizations>
<authorization>
<permissions>
<permission>
DESCRIO
Cdigo da permisso.
Tipo: Texto.
Valor
<authorizationSearchResult>
<authorizations>
<authorization>
<permissions>
<permission>
<code>
<authorizationSearchResult>
<authorizations>
<authorization>
<permissions>
<permission>
<status>
<authorizationSearchResult>
<authorizations>
<authorization>
<permissions>
<permission>
<lastUpdate>
VERSO 1.0.4
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
intermediou para voc
MANAGE_PAYMENT_PRE_APPROVALS
A aplicao poder
gerenciar e utilizar
pr-aprovaes de
pagamentos para voc
Descrio
Pendente de aprovao
Aprovado pelo cliente
Negado pelo cliente
32
MODELO DE APLICAES
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.
5.
</error>
6. </errors>
DESCRIO
<errors>
Lista de erros.
<errors>
<error>
<errors>
<error>
<code>
Cdigo do erro.
Tipo: Texto.
Formato: Ver Tabela de Erros na pgina 34.
<errors>
<error>
<message>
Mensagem descritiva.
Tipo: Texto.
Formato: Ver Tabela de Erros na pgina 34.
API de Pagamentos
Sem a utilizao do Modelo de Aplicaes, a chamada para o PagSeguro feita utilizando o e-mail e token
do cliente. Veja abaixo um exemplo da chamada sem o Modelo de Aplicaes para a API de Pagamentos (as
linhas foram quebradas para facilitar a leitura):
VERSO 1.0.4
MODELO DE APLICAES
33
Com a utilizao do Modelo de Aplicaes, a chamada para o PagSeguro feita utilizando o appId, o appKey
e o authorizationCode do cliente. Veja abaixo um exemplo da mesma chamada utilizando o Modelo de
Aplicaes (as linhas foram quebradas para facilitar a leitura):
curl https://ws.pagseguro.uol.com.br/v2/checkout/ -d\
"appId=lojamodelo\
&appKey=CAD9C79F4141DF222401CF940D6F0682\
&authorizationCode=D8DD848AC9C98D9EE44C5FB3A1E53913\
¤cy=BRL\
&itemId1=0001\
&itemDescription1=Notebook Prata\
&itemAmount1=24300.00\
&itemQuantity1=1\
&itemWeight1=1000\
&reference=REF1234\
&senderName=Jose Comprador\
&senderAreaCode=11\
&senderPhone=56273440\
&senderEmail=comprador@uol.com.br\
VERSO 1.0.4
MODELO DE APLICAES
34
&shippingType=1\
&shippingAddressStreet=Av. Brig. Faria Lima\
&shippingAddressNumber=1384\
&shippingAddressComplement=5o andar\
&shippingAddressDistrict=Jardim Paulistano\
&shippingAddressPostalCode=01452002\
&shippingAddressCity=Sao Paulo\
&shippingAddressState=SP\
&shippingAddressCountry=BRA"
API de Notificaes
A API de Notificaes a nica API onde no necessrio o authorizationCode. Veja abaixo um exemplo da
chamada para esta API sem o Modelo de (as linhas foram quebradas para facilitar a leitura):
https://ws.pagseguro.uol.com.br/v2/transactions/notifications
/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 conforme abaixo (as linhas foram quebradas para facilitar a leitura):
https://ws.pagseguro.uol.com.br/v2/transactions/notifications
/9E884542-81B3-4419-9A75-BCC6FB495EF1
?appId=lojamodelo
&appKey=D8DD848AC9C98D9EE44C5FB3A1E53913
API de Consultas
Veja abaixo um exemplo da chamada para esta API de Consulta de Transaes sem o Modelo de (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
VERSO 1.0.4
MODELO DE APLICAES
35
Utilizando o modelo de aplicaes basta que voc passe, ao invs do e-mail e token do cliente, o appId,
appKey e o authorizationCode conforme abaixo (as linhas foram quebradas para facilitar a leitura):
https://ws.pagseguro.uol.com.br/v2/transactions
/9E884542-81B3-4419-9A75-BCC6FB495EF1
?appId=lojamodelo
&appKey=D8DD848AC9C98D9EE44C5FB3A1E53913
&authorizationCode=D8DD848AC9C98D9EE44C5FB3A1E53913
O mesmo processo pode ser aplicado para as consultas de Histrico de transaes e para a consulta de
Transaes abandonadas.
Criao de Assinaturas
Veja abaixo um exemplo da chamada para esta API de Assinaturas sem o Modelo de (as linhas foram
quebradas para facilitar a leitura):
curl -k https://ws.pagseguro.uol.com.br/v2/pre-approvals/request -d\
"email=suporte@lojamodelo.com.br\
&token=95112EE828D94278BD394E91C4388F20\
&reference=REF1234\
&redirectURL=http://www.notebookprata.com.br/retorno.php\
&reviewURL=http://www.notebookprata.com.br/revisao.php\
&preApprovalCharge=manual\
&preApprovalName=Seguro contra roubo do Notebook Prata\
&preApprovalDetails=Seguro contra roubo do Notebook Prata.\
&preApprovalAmountPerPayment=100.00\
&preApprovalPeriod=Monthly\
&preApprovalDayOfMonth=28\
&preApprovalMaxPaymentsPerPeriod=1\
&preApprovalMaxAmountPerPeriod=100.00\
&preApprovalInitialDate=2013-09-01T00:00:000-03:00\
&preApprovalFinalDate=2013-12-01T00:00:000-03:00\
&preApprovalMaxTotalAmount=400.00
Com a utilizao do Modelo de Aplicaes, a chamada para o PagSeguro feita utilizando o appId, o appKey
e o authorizationCode do cliente. Veja abaixo um exemplo da mesma chamada utilizando o Modelo de
Aplicaes (as linhas foram quebradas para facilitar a leitura):
VERSO 1.0.4
36
MODELO DE APLICAES
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 conforme a
Imagem 10.
Link: https://pagseguro.uol.com.br/aplicacao/listarAutorizacoes.jhtml
Imagem 10
VERSO 1.0.4
37
MODELO DE APLICAES
Tabela de Erros
Caso sua aplicao informe algum dado incorreto ou fora do padro esperado pela aplicao, ser retornado
uma mensagem informando o problema. Confira abaixo os erros que podem ser retornados:
HTTP 401 - Unauthorized
Ocorre quando sua aplicao encaminhou uma credencial (e-mail ou token) invalida ou inexistente.
HTTP 405 Method Not Allowed
Ocorre quando sua aplicao efetuou a chamada utilizando um mtodo no esperado. Neste caso verifique
se o mtodo da chamada GET ou POST.
HTTP 415 Cannot consume content type
Ocorre quando no encaminhado o Content-Type na chamada.
HTTP 400 Bad Request
Ocorre quando um ou mais dados foram encaminhados de forma incorreta ou fora do padro. Este retorno
possui um XML no corpo na mensagem que identifica quais os erros presentes na chamada. O XML possui o
seguinte formato:
PARMETRO
DESCRIO
12001
appId is required.
12002
appKey is required.
12003
permissions is required.
12004
redirectURL is required.
12005
12006
12007
12008
12009
12010
12011
12012
12013
50110
VERSO 1.0.4
38
MODELO DE APLICAES
PARMETRO
DESCRIO
50128
50129
50130
50132
50133
50134
50135
50136
Invalid e-mail
50137
50140
50141
50142
50143
50144
50145
50146
50147
50148
VERSO 1.0.4