Pagseguro Checkout Transparente

Guia de Integrao
Checkout Transparente
CHECKOUT TRANSPARENTE
Histrico de Verses
DATA
26/02/2013
13/09/2013
05/03/2014
21/05/2014
26/08/2014
06/10/2014
02/02/2015
20/08/2015
07/03/2016
DESCRIO
Viso Geral
Reviso
Reviso
Incluso de informao sobre o getSenderHash
Incluso de informaes sobre o getPaymentMethods
Incluso de informaes sobre parcelamento sem juros
Reviso da tabela de erros
Incluso do parmetro amount no mtodo getPaymentMethods
Alterao de nomenclatura dos status de retorno 7 e 8.
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.3
O PagSeguro prov todas as ferramentas necessrias para

que voc efetue a sua integrao de forma rpida e fcil.
Confira abaixo nossas ferramentas e canais:
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.3
ndice
Histrico de Verses ...................................................................................................................... 2
Copyright ....................................................................................................................................... 2
Aviso Legal ..................................................................................................................................... 2
Viso Geral..................................................................................................................................... 5
Integrao ..5
Iniciando uma sesso de pagamento ............................................................................................ 5
Integraes no browser................................................................................................................. 6
Obter identificao do comprador ....................................................................................... 6
Obter os meios de pagamento ............................................................................................. 7
Obter bandeira do carto de crdito .................................................................................... 9
Obter token do carto de crdito ....................................................................................... 10
Obter opes de parcelamento .......................................................................................... 11
API do Checkout Transparente..12
Exemplo de chamada para Boleto............................................................................................... 13
Exemplo de chamada para Dbito .............................................................................................. 14
Exemplo de chamada para Carto de Crdito............................................................................. 15
Retorno da API do Checkout Transparente..16
Listagem de Parmetros.17
Autenticao................................................................................................................................ 17
Parmetros da API do Checkout Transparente ........................................................................... 18
Parmetros de retorno da API do Checkout Transparente ......................................................... 28
Tabela de Erros.39
Anexos44
Exemplo de chamada para Boleto............................................................................................... 44
Exemplo de chamada para Dbito .............................................................................................. 46
Exemplo de chamada para Carto de Crdito............................................................................. 47
VERSO 1.0.3
Viso Geral
A API do Checkout Transparente oferece maior controle e flexibilidade sobre o processo de pagamento. Com
essa integrao o cliente fica no ambiente do seu e-commerce ou site durante todo o processo de compra,
sem necessidade de cadastro ou pginas intermedirias de pagamento. Com ele possvel disponibilizar em
seu site os meios de pagamento Carto de Crdito, Dbito Online e Boleto.
O Checkout Transparente est disponvel para contas do tipo Vendedor e Empresarial.
As sees seguintes indicaro como possvel integrar seu sistema de pagamentos ao Checkout
Transparente do PagSeguro.
O Checkout Transparente pode ser utilizado em ambiente Sandbox. Para utilizar o
ambiente de testes basta adicionar o prefixo sandbox nas URLs. Durante a
documentao, os prefixos sero apresentados em vermelho.
Ateno: A biblioteca Java do PagSeguro j possui suporte ao Checkout Transparente.
Para saber mais sobre esta biblioteca acesse: https://pagseguro.uol.com.br/v2/guia-deintegracao/tutorial-da-biblioteca-pagseguro-em-java.html
Integrao
Para fazer a integrao do Checkout Transparente, voc precisa seguir os seguintes passos:
Iniciar uma sesso de pagamento (Todos os meios de pagamento)
Obter os meios de pagamento (Todos os meios de pagamento)
Obter a bandeira do carto de crdito (Apenas para Carto de Crdito)
Obter o token do carto de crdito (Apenas para Carto de Crdito)
Verificar as opes de parcelamento (Apenas para Carto de Crdito)
Obter a identificao do comprador (Todos os meios de pagamento)
Efetuar o pagamento utilizando a API do Checkout Transparente (Todos os meios de pagamento)
Iniciando uma sesso de pagamento

Para iniciar um Checkout Transparente necessrio ter um ID de sesso vlido. Este servio retorna o ID de
sesso que ser usado nas chamadas JavaScript. A chamada deve ser efetuada para a URL abaixo utilizando o
mtodo POST.
URL:
POST https://ws.sandbox.pagseguro.uol.com.br/v2/sessions
Exemplo:
curl https://ws.sandbox.pagseguro.uol.com.br/v2/sessions/ -d\
"email=suporte@lojamodelo.com.br\
&token=95112EE828D94278BD394E91C4388F20\
VERSO 1.0.3
Retorno:
1. <?xml version="1.0" encoding="ISO-8859-1"?>
2. <session>
3.
<id>620f99e348c24f07877c927b353e49d3</id>
4. </session>
Integraes no browser
A API do Checkout Transparente possui funes JavaScript para algumas operaes que devem ser executadas
no browser do cliente, funes que sero descritas mais adiante. Para essas funes uma API JavaScript deve
ser importada no final da pgina dos meios de pagamento:
<script type="text/javascript" src=
"https://stc.sandbox.pagseguro.uol.com.br/pagseguro/api/v2/checkout/pagseguro.directpayment.js"></
script>
Esse JavaScript possui um objeto chamado PagSeguroDirectPayment, que a interface de acesso aos
mtodos. Aps importar o arquivo, deve ser executado o mtodo setSessionId com o ID de sesso gerado
anteriormente.
<script type="text/javascript">
PagSeguroDirectPayment.setSessionId('ID_DA_SESSO');
</script>
Nas funes abaixo os eventos de sucesso e erro ocorrem em chamadas callback no JavaScript que so
passadas via JSON.
Para isso basta passar trs funes JavaScript com nome success, error e complete via JSON na chamada
dos mtodos. A funo complete ser chamada independente do retorno e as funes success e error
sero chamadas dependendo do retorno, ou seja, se o retorno no possuir erro a funo chamada ser a
success e se possuir erro a funo chamada ser a error.
Obter identificao do comprador

Para realizar o Checkout Transparente necessrio enviar um identifilcador do comprador gerado pelo
JavaScript. Para isso voc deve utilizar o mtodo getSenderHash. Este mtodo no possui parmetros e
retorna um identificador. O identificador obrigatrio para todos os meios de pagamento.
Sintaxe:
PagSeguroDirectPayment.getSenderHash();
Ateno: Este mtodo possui algumas dependncias e, por isso, recomendamos que o
getSenderHash no seja executado no onLoad da pgina. Voc pode executa-lo, por
exemplo quando o cliente clicar no boto de concluso de pagamento.
VERSO 1.0.3
Obter os meios de pagamento

Nesse processo voc pode obter todos os meios de pagamento disponveis em sua conta para exibio no
checkout. Para isso voc dever utilizar o mtodo getPaymentMethods. Esse mtodo recebe opcionalmente
o valor da transao e retorna um JSON que contm os meios de pagamentos disponveis no PagSeguro,
compatveis com o valor informado. Caso no seja informado o valor, ser retornado todos os meios de
pagamento. O JSON possui informaes como o nome utilizado na API, nome de exibio, status
(Disponibilidade) e tambm o caminho para as imagens do meio de pagamento.
Veja abaixo um JSON de exemplo (o JSON foi reduzida para melhor visualizao):
Sintaxe:
1. PagSeguroDirectPayment.getPaymentMethods({
2.
amount: {valor da transao}
3.
success: {funo de callback para chamadas bem sucedidas},
4.
error: {funo de callback para chamadas que falharam},
5.
complete: {funo de callback para todas chamadas}
6. });
Exemplo:
1. PagSeguroDirectPayment.getPaymentMethods({
2.
amount: 500.00
3.
success: function(response) {
4.
//meios de pagamento disponveis
5.
},
6.
error: function(response) {
7.
//tratamento do erro
8.
9.
},
complete: function(response) {
10.
11.
//tratamento comum para todas chamadas

}
12. });
Retorno
1. {
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
"error":false,
"paymentMethods":{
"BOLETO":{
"name":"BOLETO",
"options":{
"BOLETO":{
"name":"BOLETO",
"displayName":"Boleto",
"status":"AVAILABLE",
"code":202,
"images":{
"SMALL":{
"size":"SMALL",
"path":"/public/img/payment-methods-flags/42x20/booklet.png"
},
VERSO 1.0.3
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70. }}
"MEDIUM":{
"size":"MEDIUM",
"path":"/public/img/payment-methods-flags/68x30/booklet.png"
}
}
}
},
"code":2
},
"ONLINE_DEBIT":{
"name":"ONLINE_DEBIT",
"options":{
"BANCO_BRASIL":{
"name":"BANCO_BRASIL",
"displayName":"Banco do Brasil",
"code":304,
"images":{
"SMALL":{
"size":"SMALL",
"path":"/public/img/payment-methods-flags/42x20/bb.png"
},
"MEDIUM":{
"size":"MEDIUM",
"path":"/public/img/payment-methods-flags/68x30/bb.png"
}
}
},
},
"code":3
},
"CREDIT_CARD":{
"name":"CREDIT_CARD",
"options":{
"MASTERCARD":{
"name":"MASTERCARD",
"displayName":"MasterCard",
"code":102,
"images":{
"SMALL":{
"size":"SMALL",
"path":"/public/img/payment-methods-flags/42x20/mastercard.png"
},
"MEDIUM":{
"size":"MEDIUM",
"path":"/public/img/payment-methods-flags/68x30/mastercard.png"
}
}
},
},
"code":1
}
As imagens so disponibilizadas em dois tamanhos: 42x20 e 68x30 e podem ser obtidas atravs dos
caminhos apresentados no JSON, bastando incluir a URL https://stc.pagseguro.uol.com.br.
Veja abaixo dois exemplos de imagens e suas URLs:
Imagem Pequena
https://stc.pagseguro.uol.com.br/public/img/payment-methods-flags/42x20/visa.png
Imagem Grande
https://stc.pagseguro.uol.com.br/public/img/payment-methods-flags/68x30/visa.png
VERSO 1.0.3
Obter bandeira do carto de crdito

Esse processo necessrio somente para o meio de pagamento carto de crdito. O mtodo getBrand
utilizado para verificar qual a bandeira do carto que est sendo digitado. Esse mtodo recebe por parmetro
o BIN do carto (seis primeiros dgitos do carto) e retorna dados como qual a bandeira, o tamanho do CVV,
se possui data de expirao e qual algoritmo de validao. A chamada desse servio no obrigatria.
Sintaxe:
71. PagSeguroDirectPayment.getBrand({
72.
cardBin: {BIN do nmero do carto},
73.
74.
75.
76. });
Exemplo:
1. PagSeguroDirectPayment.getBrand({
2.
cardBin: $("input#cartao").val(),
3.
4.
//bandeira encontrada
5.
},
6.
7.
8.
9.
},
10.
11.
12. });
Retorno:
1. {
2.
"brand":{
3.
"name":"visa",
4.
"bin":411111,
5.
"cvvSize":3,
6.
"expirable":true,
7.
"validationAlgorithm":"LUHN"
8.
9. }
VERSO 1.0.3
10
Obter token do carto de crdito

Esse processo necessrio somente para o meio de pagamento carto de crdito. O mtodo createCardToken
utilizado para gerar o token que representar o carto de crdito na chamada para a API do Checkout
Transparente. Este mtodo recebe os seguintes dados: nmero do carto (obrigatrio), CVV (opcional para
alguns cartes), data de expirao (opcional para alguns cartes) e a bandeira (obrigatrio).
Sintaxe:
1. PagSeguroDirectPayment.createCardToken({
2.
cardNumber: {nmero},
3.
brand: {bandeira},
4.
cvv: {cdigo de segurana},
5.
expirationMonth: {ms de expirao},
6.
expirationYear: {ano de expirao},
7.
8.
9.
10. });
Exemplo:
1. var param = {
2.
cardNumber: $("input#cartao").val(),
3.
cvv: $("input#cvv").val(),
4.
expirationMonth: $("input#validadeMes").val(),
5.
expirationYear: $("input#validadeAno").val(),
6.
7.
8.
//token gerado, esse deve ser usado na chamada da API do Checkout Transparente
},
9.
10.
11.
12.
},
13.
14.

}
15. }
16.
17. //parmetro opcional para qualquer chamada
18. if($("input#bandeira").val() != '') {
19.
param.brand = $("input#bandeira").val();
20. }
21.
22. PagSeguroDirectPayment.createCardToken(param);
VERSO 1.0.3
11
Retorno:
1. {
2.
"card":{
3.
4.
"token":"653fe9044cf149f9b7db562431cb130d"
}
5. }
Obter opes de parcelamento

Esse processo necessrio apenas para o meio de pagamento carto de crdito. Caso queira mostrar as
opes de parcelamento para o comprador, voc dever utilizar o mtodo getInstallments. Esse mtodo
recebe o valor a ser parcelado (obrigatrio), a quantidade de parcelas sem juros e a bandeira que se deseja
obter o parcelamento, retornando as configuraes de cada parcela sendo: valor total do pagamento (que
deve ser enviado junto na API do Checkout Transparente), valor e quantidade da parcela (que tambm devem
ser informados na API do Checkout Transparente) e um indicador se aquela parcela tem juros ou no (caso o
vendedor tenha configurado uma promoo no PagSeguro).
Se no for informado uma bandeira como parmetro na chamada, o mtodo retornar os dados para todas
bandeiras aceitas pelo PagSeguro.
Sintaxe:
1. PagSeguroDirectPayment.getInstallments({
2.
amount: {valor do pagamento},
3.
maxInstallmentNoInterest: {quantidade de parcelas sem juros},
4.
brand: {bandeira do carto},
5.
6.
7.
8. });
Exemplo:
1. PagSeguroDirectPayment.getInstallments({
2.
amount: $("input#valorPagto").val(),
3.
brand: $("input#bandeira").val(),
4.
maxInstallmentNoInterest: 2,
5.
6.
//opes de parcelamento disponvel
7.
},
8.
9.
10.
11.
},
12.
13.

}
14. });
VERSO 1.0.3
12
Retorno:
1. {
2.
"error":false,
3.
"installments":{
4.
"visa":[
5.
6.
"quantity":1,
7.
"totalAmount":16,
8.
"installmentAmount":16,
9.
"interestFree":true
10.
},{
11.
"quantity":2,
12.
"totalAmount":16.48,
13.
"installmentAmount":8.24,
14.
"interestFree":false
15.
16.
17.
]
}
18. }
API do Checkout Transparente

Aps obter os dados de pagamento voc deve efetuar a chamada para o servio do checkout transparente
enviando os dados do comprador e do pagamento para realizar a cobrana. A chamada deve ser efetuada
utilizando o mtodo POST.
URL:
POST https://ws.sandbox.pagseguro.uol.com.br/v2/transactions
O cabealho Content-Type deve ser informado como no exemplo abaixo:

Content-Type: application/x-www-form-urlencoded; 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.
Cada pagamento pode conter um ou mais itens. Cada item representa um produto ou qualquer outro bem
que est sendo comprado. Os parmetros associados a itens tm seu nome terminando em um nmero.
Por exemplo: os parmetros itemId1, itemDescription1, itemAmount1 e itemQuantity1 referem-se ao
primeiro item do pagamento, enquanto que os parmetros itemId2, itemDescription2, itemAmount2 e
itemQuantity2 referem-se ao segundo item do pagamento.
Abaixo apresentamos um exemplo dos parmetros da chamada via http para cada um dos meios de
pagamento. Os exemplos em XML sero apresentados no final da documentao devido ao tamanho dos
XMLs.
VERSO 1.0.3
13
Exemplo de chamada para Boleto

curl https://ws.sandbox.pagseguro.uol.com.br/v2/transactions/ -d\
&token=95112EE828D94278BD394E91C4388F20\
&paymentMode=default\
&paymentMethod=boleto\
&receiverEmail=suporte@lojamodelo.com.br\
&currency=BRL\
&extraAmount=1.00
&itemId1=0001\
&itemDescription1=Notebook Prata\
&itemAmount1=24300.00\
&itemQuantity1=1\
&notificationURL=https://sualoja.com.br/notifica.html\
&reference=REF1234\
&senderName=Jose Comprador\
&senderCPF=22111944785\
&senderAreaCode=11\
&senderPhone=56273440\
&senderEmail=comprador@uol.com.br\
&senderHash=abc123\
&shippingAddressStreet=Av. Brig. Faria Lima\
&shippingAddressNumber=1384\
&shippingAddressComplement=5o andar\
&shippingAddressDistrict=Jardim Paulistano\
&shippingAddressPostalCode=01452002\
&shippingAddressCity=Sao Paulo\
&shippingAddressState=SP\
&shippingAddressCountry=BRA
&shippingType=1
&shippingCost=1.00"
Os parmetros em XML desta chamada esto disponveis no anexo desta documentao e devem conter o
cabealho Content-Type como o 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.
VERSO 1.0.3
Exemplo de chamada para Dbito

&token=95112EE828D94278BD394E91C4388F20\
&paymentMethod=eft\
&bankName=itau\
&currency=BRL\
&extraAmount=1.00
&itemId1=0001\
&itemQuantity1=1\
&reference=REF1234\
&senderCPF=22111944785\
&senderAreaCode=11\
&senderHash=abc123\
&shippingType=1
&shippingCost=1.00"
Os parmetros em XML desta chamada esto disponveis no anexo desta documentao.
VERSO 1.0.3
14
Exemplo de chamada para Carto de Crdito

&token=95112EE828D94278BD394E91C4388F20\
&paymentMethod=creditCard\
&currency=BRL\
&extraAmount=1.00
&itemId1=0001\
&itemQuantity1=1\
&reference=REF1234\
&senderCPF=22111944785\
&senderAreaCode=11\
&senderHash=abc123\
&shippingType=1
&shippingCost=1.00
&creditCardToken=4as56d4a56d456as456dsa\
&installmentQuantity=5\
&installmentValue=125.22\
&noInterestInstallmentQuantity=2\
&creditCardHolderName=Jose Comprador\
&creditCardHolderCPF=22111944785\
&creditCardHolderBirthDate=27/10/1987\
&creditCardHolderAreaCode=11\
&creditCardHolderPhone=56273440
&billingAddressStreet=Av. Brig. Faria Lima\
&billingAddressNumber=1384\
&billingAddressComplement=5o andar\
&billingAddressDistrict=Jardim Paulistano\
&billingAddressPostalCode=01452002\
&billingAddressCity=Sao Paulo\
&billingAddressState=SP\
&billingAddressCountry=BRA\"
Os parmetros em XML desta chamada esto disponveis no anexo desta documentao.
VERSO 1.0.3
15
16
Retorno da API do Checkout Transparente

Aps a chamada para a API do Checkout Transparente, retornado um XML com todos os dados da transao
conforme o exemplo abaixo:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>

<transaction>
<date>2011-02-05T15:46:12.000-02:00</date>
<lastEventDate>2011-02-15T17:39:14.000-03:00</lastEventDate>
<code>9E884542-81B3-4419-9A75-BCC6FB495EF1</code>
<reference>REF1234</reference>
<type>1</type>
<status>3</status>
<paymentMethod>
<type>1</type>
<code>101</code>
</paymentMethod>
<paymentLink>
https://pagseguro.uol.com.br/checkout/imprimeBoleto.jhtml?code=314601B208B24A5CA53260000F7BB0D
</paymentLink>
<grossAmount>49900.00</grossAmount>
<discountAmount>0.00</discountAmount>
<feeAmount>0.00</feeAmount>
<netAmount>49900.50</netAmount>
<extraAmount>0.00</extraAmount>
<installmentCount>1</installmentCount>
<itemCount>2</itemCount>
<items>
<item>
<id>0001</id>
<description>Notebook Prata</description>
<quantity>1</quantity>
<amount>24300.00</amount>
</item>
<item>
<id>0002</id>
<description>Notebook Rosa</description>
</item>
</items>
<sender>
<name>Jos Comprador</name>
<email>comprador@uol.com.br</email>
<phone>
<areaCode>11</areaCode>
<number>56273440</number>
</phone>
</sender>
<shipping>
<address>
<street>Av. Brig. Faria Lima</street>
<complement>5o andar</complement>
<district>Jardim Paulistano</district>
<postalCode>01452002</postalCode>
VERSO 1.0.3
17
52.
<city>Sao Paulo</city>
53.
<state>SP</state>
54.
<country>BRA</country>
55.
</address>
56.
<type>1</type>
57.
<cost>21.50</cost>
58.
</shipping>
59. </transaction>
Caso ocorra algum erro na chamada por erro nos parmetros informados um XML de erro ser retornado.
Ele indicar os erros identificados na chamada. Veja o exemplo abaixo:
1. <errors>
2.
<error>
3.
<code>53031</code>
4.
<message>shipping address city is required.</message>
5.
</error>
6. </errors>
No exemplo acima a chamada foi efetuada com um valor invlido para o parmetro preApprovalFinalDate.
Os parmetros deste retorno esto descritos na listagem de parmetros.
Para os meios Boleto e Dbito, o XML possui o item paymentLink que retorna um link acesso,
respectivamente, a imagem do boleto e para a pgina de pagamento do banco selecionado.
Ateno: A pgina do banco no deve ser aberta em um IFrame.
Listagem de Parmetros
Veja abaixo a listagem completa de todos os parmetros. Todos os parmetros so Case sensitive:
Autenticao
PARMETRO
DESCRIO
email
Especifica o e-mail associado conta PagSeguro que est realizando a requisio.

Presena: Obrigatria.
Tipo: Texto.
Formato: Um e-mail vlido associado a uma conta PagSeguro do tipo Vendedor ou
Empresarial.
token
Especifica o token correspondente conta PagSeguro que est realizando a

requisio.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
VERSO 1.0.3
18
Parmetros da API do Checkout Transparente

PARMETRO
Parmetro HTTP:
receiverEmail
Elemento XML:
<payment>
<receiver>
<email>
Parmetro HTTP:
notificationURL
Elemento XML:
<payment>
<notificationURL
Parmetro HTTP:
currency
Elemento XML:
<payment>
<currency>
Parmetro HTTP:
paymentMethod
Elemento XML:
<payment>
<method>
Parmetro HTTP:
paymentMode
Elemento XML:
<payment>
<mode>
Parmetro HTTP:
itemId1, itemId2, etc.
Elemento XML:
<checkout>
<items>
<item>
<id>
VERSO 1.0.3
DESCRIO
Especifica o e-mail que deve vai receber o pagamento
Presena: Opcional.
Tipo: Texto.
Formato: Um e-mail vlido, com limite de 60 caracteres. O e-mail informado
deve estar vinculado conta PagSeguro que est realizando a chamada
API.
URL para envio de notificaes.
Presena: Opcional
Tipo: Texto
Formato: Uma URL vlida, com limite de 255 caracteres.
Moeda utilizada.
Indica a moeda na qual o pagamento ser feito. No momento, a nica opo
disponvel BRL (Real).
Tipo: Texto.
Formato: Somente o valor BRL aceito.
Meio de pagamento
Tipo: Texto.
Formato: creditCard, boleto ou eft.
Modo do pagamento
Presena: Obrigatrio.
Tipo: Texto.
Formato: aceita a opo default.
Identificadores dos itens.

Identificam os itens sendo pagos. Voc pode escolher cdigos que tenham
significado para seu sistema e inform-los nestes parmetros. O PagSeguro
no realiza qualquer validao sobre esses identificadores, mas eles no
podem se repetir em um mesmo pagamento.
Tipo: Texto.
Formato: Livre, com limite de 100 caracteres.
19
PARMETRO
Parmetro HTTP:
itemDescription1,
itemDescription2, etc.
Elemento XML:
<payment>
<items>
<item>
<description>
Parmetro HTTP:
itemAmount1, itemAmount2,
etc.
Elemento XML:
<checkout>
<items>
<item>
<amount>
Parmetro HTTP:
itemQuantity1,
itemQuantity2, etc.
Elemento XML:
<payment>
<items>
<item>
<quantity>
Parmetro HTTP:
reference
Elemento XML:
<payment>
<reference>
Parmetro HTTP:
extraAmount
Elemento XML:
<payment>
<extraAmount>
VERSO 1.0.3
DESCRIO
Descries dos itens.
Descrevem os itens sendo pagos. A descrio o texto que o PagSeguro
mostra associado a cada item quando o comprador est finalizando o
pagamento, portanto importante que ela seja clara e explicativa.
Tipo: Texto.
Valores unitrios dos itens.
Representam os preos unitrios de cada item sendo pago. Alm de poder
conter vrios itens, o pagamento tambm pode conter vrias unidades do
mesmo item. Este parmetro representa o valor de uma unidade do item,
que ser multiplicado pela quantidade para obter o valor total dentro do
pagamento.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto (p.e.,
1234.56), maior que 0.00 e menor ou igual a 9999999.00.
Quantidades dos itens.
Representam as quantidades de cada item sendo pago. Alm de poder
conter vrios itens, o pagamento tambm pode conter vrias unidades do
mesmo item. Este parmetro representa a quantidade de um item, que ser
multiplicado pelo valor unitrio para obter o valor total dentro do
pagamento.
Tipo: Nmero.
Formato: Um nmero inteiro maior ou igual a 1 e menor ou igual a 999.
Cdigo de referncia.
Define um cdigo para fazer referncia ao pagamento. Este cdigo fica
associado transao criada pelo pagamento e til para vincular as
transaes do PagSeguro s vendas registradas no seu sistema.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 200 caracteres.
Valores extras a serem cobrados
Presena: Opcional.
Tipo: Nmero.
20
PARMETRO
Elemento XML:
<payment>
<sender>
DESCRIO
Dados do comprador.
Parmetro HTTP:
senderEmail
E-mail do comprador.
Elemento XML:
<payment>
<sender>
<email>
Tipo: Texto.
Formato: um e-mail vlido (p.e., usuario@site.com.br), com no mximo 60
caracteres.
Parmetro HTTP:
senderName
Nome completo do comprador.
Elemento XML:
<payment>
<sender>
<name>
Especifica o e-mail do comprador que est realizando o pagamento.
Especifica o nome completo do comprador que est realizando o

pagamento.
Tipo: Texto.
Formato: No mnimo duas sequncias de caracteres, com o limite total de 50
caracteres.
Elemento XML:
<payment>
<sender>
<documents>
Lista de documentos do comprador.
Elemento XML:
<payment>
<sender>
<documents>
<document>
Representa um documento do comprador.
Elemento XML:
<payment>
<sender>
<documents>
<document>
<type>
Tipo de documento do comprador.

Especifica o tipo de documento do comprador que est realizando o
pagamento. Este campo opcional e voc pode envi-lo caso j tenha
capturado os dados do comprador em seu sistema e queira evitar que ele
preencha esses dados novamente no PagSeguro.
Tipo: Texto.
Formato: Case sensitive. Os valores CPF e CNPJ so aceitos.
VERSO 1.0.3
21
PARMETRO
Parmetro HTTP:
senderCPF
Elemento XML:
<payment>
<sender>
<documents>
<document>
<value>
Parmetro HTTP:
senderCNPJ
Elemento XML:
<payment>
<sender>
<documents>
<document>
<value>
Parmetro HTTP:
senderAreaCode
Elemento XML:
<payment>
<sender>
<phone>
<areaCode>
Parmetro HTTP:
senderPhone
Elemento XML:
<payment>
<sender>
<phone>
<number>
DESCRIO
CPF do comprador
Tipo: Texto.
Formato: Nmero.
CNPJ do comprador
Tipo: Texto.
Formato: Nmero.
DDD do comprador.
Especifica o cdigo de rea (DDD) do comprador que est realizando o
pagamento.
Tipo: Nmero.
Formato: Um nmero de 2 dgitos correspondente a um DDD vlido.
Nmero do telefone do comprador.
Especifica o nmero do telefone do comprador que est realizando o
pagamento
Tipo: Nmero.
Formato: Um nmero de 7 a 9 dgitos.
Parmetro HTTP:
senderHash
Identificador do vendedor.
Elemento XML:
<payment>
<sender>
<hash>
Tipo: Texto.
Formato: Obtido a partir de uma chamada javascript
PagseguroDirectPayment.getSenderHash()
Elemento XML:
<payment>
<shipping>
Dados da Entrega
VERSO 1.0.3
Identificador do vendedor (fingerprint) gerado pelo JavaScript do PagSeguro
22
PARMETRO
Parmetro HTTP:
shippingType
Elemento XML:
<payment>
<shipping>
<type>
Parmetro HTTP:
shippingCost
Elemento XML:
<payment>
<shipping>
<cost>
DESCRIO
Forma de envio do produto.
Presena: Obrigatrio caso seja informado o shippingCost.
Tipo: Nmero.
Formato: 1 PAC, 2 SEDEX, 3 - Desconhecido
Valor do frete
Presena: Opcional.
Tipo: Nmero.
Elemento XML:
<payment>
<shipping>
<address>
Dados do endereo de envio
Parmetro HTTP:
shippingAddressCountry
Pas do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<country>
Tipo: Texto.
Formato: No momento, apenas o valor BRA permitido.
Parmetro HTTP:
shippingAddressState
Estado do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<state>
Tipo: Texto.
Formato: Duas letras, representando a sigla do estado brasileiro
correspondente.
Parmetro HTTP:
shippingAddressCity
Cidade do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<city>
Tipo: Texto.
Formato: Livre. Deve ser um nome vlido de cidade do Brasil, com no
mnimo 2 e no mximo 60 caracteres.
VERSO 1.0.3
Informa o pas do endereo de envio do produto.
Informa o estado do endereo de envio do produto.
Informa a cidade do endereo de envio do produto.
23
PARMETRO
DESCRIO
Parmetro HTTP:
shippingAddressPostalCode
CEP do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<postalCode>
Tipo: Nmero.
Formato: Um nmero de 8 dgitos.
Parmetro HTTP:
shippingAddressDistrict
Bairro do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<district>
Tipo: Texto.
Parmetro HTTP:
shippingAddressStreet
Nome da rua do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<street>
Tipo: Texto.
Parmetro HTTP:
shippingAddressNumber
Nmero do endereo de envio.

Informa o nmero do endereo de envio do produto.
Elemento XML:
<payment>
<shipping>
<address>
<number>
Tipo: Texto.
Parmetro HTTP:
shippingAddressComplement
Complemento do endereo de envio.
Elemento XML:
<payment>
<shipping>
<address>
<complement>
VERSO 1.0.3
Informa o CEP do endereo de envio do produto.
Informa o bairro do endereo de envio do produto.
Informa o nome da rua do endereo de envio do produto.
Informa o complemento (bloco, apartamento, etc.) do endereo de envio do

produto.
Presena: Opcional.
Tipo: Texto.
24
PARMETRO
DESCRIO
DADOS PARA TRANSAES VIA DBITO ONLINE
Elemento XML:
<payment>
<bank>
Parmetro HTTP:
bankName
Dados do banco.
Nome do Banco
Nome de banco para qual vai ser gerado o link de redirecionamento
Elemento XML:
<payment>
<bank>
<name>
Presena: Obrigatrio para Dbito Online.

Tipo: Texto
Formato: bradesco, itau, bancodobrasil, banrisul ou hsbc
DADOS PARA TRANSAES VIA CARTO DE CRDITO

Parmetro HTTP:
creditCardToken
Token do Carto de Crdito
Elemento XML:
<payment>
<creditCard>
<token>
Token retornado no servio de obteno de token do carto de crdito

(pg.: 9).
Presena: Obrigatrio para Carto de Crdito
Tipo: Texto
Formato: No tem limite de caracteres
Parmetro HTTP:
installmentQuantity
Quantidade de parcelas
Quantidade de parcelas escolhidas pelo cliente.
Elemento XML:
<payment>
<creditCard>
<installment>
<quantity>
Presena: Obrigatrio para Carto de Crdito.

Tipo: Inteiro
Valores aceitos: [1, 18]
Parmetro HTTP:
installmentValue
Valor das parcelas

Valor das parcelas obtidas no servio de opes de parcelamento.
Elemento XML:
<payment>
<creditCard>
<installment>
<value>
VERSO 1.0.3

Tipo: Nmero
Formato: Numrico com 2 casas decimais e separado por ponto. Ex: 1111.11
25
PARMETRO
Parmetro HTTP:
noInterestInstallmentQuantity
Elemento XML:
<payment>
<creditCard>
<installment>
<noInterestInstallmentQuantity>
Parmetro HTTP:
creditCardHolderName
Elemento XML:
<payment>
<creditCard>
<holder>
<name>
Parmetro HTTP:
creditCardHolderBirthDate
Elemento XML:
<payment>
<creditCard>
<holder>
<birthDate>
DESCRIO
Quantidade de parcelas sem juros
Quantidade de parcelas sem juros oferecidas ao cliente. O valor deve ser o
mesmo indicado no mtodo getInstallments, no parmetro
maxInstallmentNoInterest.
Presena: Obrigatrio caso tenha sido informado o valor no parmetro
maxInstallmentNoInterest do mtodo getInstallments.
Tipo: Nmero
Formato: Inteiro. Ex: 10
Nome impresso no carto de crdito
Tipo: Texto
Formato: min = 1, max = 50 caracteres
Data de nascimento do dono do carto de crdito

Tipo: dd/MM/yyyy
Formato: 31/12/2013
Elemento XML:
<payment>
<creditCard>
<holder>
<documents>
Lista de documentos do dono do carto de crdito.
Elemento XML:
<payment>
<creditCard>
<holder>
<documents>
<document>
Representa um documento do dono do carto de crdito.
Elemento XML:
<payment>
<creditCard>
<holder>
<documents>
<document>
<type>
Tipo de documento do dono do carto de crdito.

Especifica o tipo de documento do dono do carto de crdito que est
sendo usado para realizar o pagamento.
VERSO 1.0.3

Tipo: Texto.
Formato: Case sensitive. Somente o valor CPF aceito.
26
PARMETRO
Parmetro HTTP:
creditCardHolderCPF
Elemento XML:
<payment>
<creditCard>
<holder>
<documents>
<document>
<value>
DESCRIO
CPF do dono do carto de crdito
Tipo: Texto
Elemento XML:
<payment>
<creditCard>
<holder>
<phone>
Telefone do dono do carto de crdito.
Parmetro HTTP:
creditCardHolderAreaCode
Cdigo de rea
Elemento XML:
<payment>
<creditCard>
<holder>
<phone>
<areaCode>
Parmetro HTTP:
creditCardHolderPhone
Elemento XML:
<payment>
<creditCard>
<holder>
<phone>
<number>

Tipo: Nmero
Telefone
Tipo: Nmero
Formato: Um nmero entre 7 e 9 dgitos.
DADOS DE ENDEREO DE COBRANA

Elemento XML:
<payment>
<creditCard>
<billingAddress>
VERSO 1.0.3
Endereo de cobrana.
27
PARMETRO
Parmetro HTTP:
billingAddressPostalCode
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<postalCode>
Parmetro HTTP:
billingAddressStreet
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<street>
Parmetro HTTP:
billingAddressNumber
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<number>
Parmetro HTTP:
billingAddressComplement
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<complement>
Parmetro HTTP:
billingAddressDistrict
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<district>
VERSO 1.0.3
DESCRIO
CEP do endereo de cobrana
Formato: Um nmero de 8 dgitos correspondente a um CEP vlido (p.e,
01452002).
Nome da Rua
Nmero
Complemento
Presena: Opcional para Carto de Crdito.
Bairro
Tipo: Texto.
28
PARMETRO
Parmetro HTTP:
billingAddressCity
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<city>
Parmetro HTTP:
billingAddressState
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<state>
Parmetro HTTP:
billingAddressCountry
Elemento XML:
<payment>
<creditCard>
<billingAddress>
<country>
DESCRIO
Cidade
Formato: Deve ser um nome vlido de cidade do Brasil, com no mnimo 2 e
no mximo 60 caracteres.
Estado
correspondente (p.e, SP).
Pas
Formato: Reconhece apenas o valor BRA.
Parmetros de retorno da API do Checkout Transparente

CAMPO
DESCRIO
<transaction>
Este campo a raiz do XML e engloba os dados da transao.
<transaction>
<date>
Data da criao da transao.

Informa o momento em que a transao foi criada.
Tipo: Data/hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C
para datas. Veja mais sobre formatao de datas.
<transaction>
<lastEventDate>
Data do ltimo evento.

Informa o momento em que ocorreu a ltima alterao no status da
transao.
Tipo: Data/hora.
VERSO 1.0.3
29
CAMPO
DESCRIO
<transaction>
<code>
Cdigo identificador da transao

Retorna o cdigo que identifica a transao de forma nica.
Tipo: Texto.
Formato: Uma sequncia de 36 caracteres.
<transaction>
<reference>
Cdigo de referncia da transao.

Informa o cdigo que foi usado para fazer referncia ao pagamento.
Este cdigo foi fornecido no momento do pagamento e til para
vincular as transaes do PagSeguro s vendas registradas no seu
sistema.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 200 caracteres.
<transaction>
<type>
Tipo da transao.
Representa o tipo da transao recebida. Os valores mais comuns para
este campo e seus respectivos resultados so descritos abaixo.
Cdigo
Significado
Pagamento: a transao foi criada por um comprador

fazendo um pagamento. Este o tipo mais comum de
transao que voc ir receber.
Outros tipos menos comuns de transaes foram omitidos. Note que

novos tipos podem ser adicionados em verses futuras da API.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<status>
Status da transao.
Informa o cdigo representando o status da transao, permitindo que
voc decida se deve liberar ou no os produtos ou servios adquiridos.
Os valores possveis esto descritos no diagrama de status de
transaes e so apresentados juntamente com seus respectivos
cdigos na tabela abaixo.
VERSO 1.0.3
30
CAMPO
DESCRIO
Cdigo
Significado
Aguardando pagamento: o comprador iniciou a

transao, mas at o momento o PagSeguro no
recebeu nenhuma informao sobre o pagamento.
Em anlise: o comprador optou por pagar com um

carto de crdito e o PagSeguro est analisando o risco
da transao.
Paga: a transao foi paga pelo comprador e o

PagSeguro j recebeu uma confirmao da instituio
financeira responsvel pelo processamento.
Disponvel: a transao foi paga e chegou ao final de

seu prazo de liberao sem ter sido retornada e sem
que haja nenhuma disputa aberta.
Em disputa: o comprador, dentro do prazo de liberao

da transao, abriu uma disputa.
Devolvida: o valor da transao foi devolvido para o

comprador.
Cancelada: a transao foi cancelada sem ter sido

finalizada.
Debitado: o valor da transao foi devolvido para o

comprador.
Reteno temporria: o comprador abriu uma

solicitao de chargeback junto operadora do carto
de crdito.
Outros status menos relevantes foram omitidos. Em resumo, voc deve

considerar transaes nos status de Paga para liberao de produtos
ou servios.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<cancellationSource>
Origem do cancelamento.
Informa a origem do cancelamento da transao: pelas instituies
financeiras (Banco Emissor ou Operadora do Carto) ou pelo
PagSeguro.
VERSO 1.0.3
31
CAMPO
DESCRIO
Valor
Significado
INTERNAL
PagSeguro
EXTERNAL
Instituies Financeiras
Presena: Opcional (somente quando transactionStatus igual a 7).

Tipo: Texto.
Formato: Valores possveis INTERNAL ou EXTERNAL.
<transaction>
<paymentMethod>
<transaction>
<paymentMethod>
<type>
VERSO 1.0.3
Dados do meio de pagamento usado pelo comprador.
Tipo do meio de pagamento.

Informa o tipo do meio de pagamento usado pelo comprador. Este tipo
agrupa diversos meios de pagamento e determina de forma geral o
comportamento da transao. A tabela abaixo descreve os valores
disponveis e seus significados.
Cdigo
Significado
Carto de crdito: o comprador escolheu pagar a

transao com carto de crdito.
Boleto: o comprador optou por pagar com um boleto

bancrio.
Dbito online (TEF): o comprador optou por pagar a

transao com dbito online de algum dos bancos
conveniados.
Saldo PagSeguro: o comprador optou por pagar a

transao utilizando o saldo de sua conta PagSeguro.
Oi Paggo *: o comprador escolheu pagar sua transao

atravs de seu celular Oi.
Depsito em conta: o comprador optou por fazer um

depsito na conta corrente do PagSeguro. Ele precisar
ir at uma agncia bancria, fazer o depsito, guardar o
comprovante e retornar ao PagSeguro para informar os
dados do pagamento. A transao ser confirmada
somente aps a finalizao deste processo, que pode
levar de 2 a 13 dias teis.
32
CAMPO
DESCRIO
* Os tipos marcados no esto disponveis para utilizao.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<paymentLink>
Link para o Pagamento.

Informa a URL para a exibio do boleto ou, quando o meio de
pagamento for TEF, a URL para abrir o pop-up do banco. Quando o
meio de pagamento for Carto de crdito este parmetro ser omitido.
Presena: Somente para pagamentos via Boleto e TEF.
Tipo: Texto.
Formato: URL
<transaction>
<paymentMethod>
<code>
VERSO 1.0.3
Cdigo identificador do meio de pagamento

Informa um cdigo que identifica o meio de pagamento usado pelo
comprador. O meio de pagamento descreve a bandeira de carto de
crdito utilizada ou banco escolhido para um dbito online. A tabela
abaixo descreve os possveis valores e seus significados.
Cdigo
Significado
101
Carto de crdito Visa.
102
Carto de crdito MasterCard.
103
Carto de crdito American Express.
104
Carto de crdito Diners.
105
Carto de crdito Hipercard.
106
Carto de crdito Aura.
107
Carto de crdito Elo.
108
Carto de crdito PLENOCard.
109
Carto de crdito PersonalCard.
110
Carto de crdito JCB.
111
Carto de crdito Discover.
33
CAMPO
DESCRIO
112
Carto de crdito BrasilCard.
113
Carto de crdito FORTBRASIL.
114
Carto de crdito CARDBAN.
115
Carto de crdito VALECARD.
116
Carto de crdito Cabal.
117
Carto de crdito Mais!.
118
Carto de crdito Avista.
119
Carto de crdito GRANDCARD.
201
Boleto Bradesco. *
202
Boleto Santander.
301
Dbito online Bradesco.
302
Dbito online Ita.
303
Dbito online Unibanco. *
304
Dbito online Banco do Brasil.
305
Dbito online Banco Real. *
306
Dbito online Banrisul.
307
Dbito online HSBC.
401
Saldo PagSeguro.
501
Oi Paggo. *
701
Depsito em conta - Banco do Brasil
* Os meios de pagamento marcados no esto disponveis para

utilizao.
Tipo: Nmero.
Formato: Inteiro.
VERSO 1.0.3
34
CAMPO
<transaction>
<grossAmount>
DESCRIO
Valor bruto da transao.
Informa o valor bruto da transao, calculado pela soma dos preos de
todos os itens presentes no pagamento.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto (".").
Por exemplo, 1234.56.
<transaction>
<discountAmount>
Valor do desconto dado.

Informa o valor do desconto dado a compradores que optaram por
pagar com dbito online ou boleto. Este desconto aplica-se quando
voc opta por incluir no preo dos produtos o custo do parcelamento
de pagamentos com carto de crdito. O desconto dado para no
onerar os compradores que optaram por meios vista.
Tipo: Nmero.
<transaction>
<feeAmount>
Valor total das taxas cobradas.

Informa o valor total das taxas cobradas pelo PagSeguro nesta
transao.
Tipo: Nmero.
<transaction>
<netAmount>
Valor lquido da transao.

Informa o valor lquido da transao, que corresponde ao valor bruto,
menos o valor das taxas. Caso presente, o valor de extraAmount (que
pode ser positivo ou negativo) tambm considerado no clculo.
Tipo: Nmero.
<transaction>
VERSO 1.0.3
Data de crdito.
35
CAMPO
<escrowEndDate>
DESCRIO
Data em que o valor da transao estar disponvel na conta do
vendedor.
Presena: Presente apenas quando o status da transao for um dos
seguintes valores:Paga (3), Disponvel (4), Em disputa (5)
ou Devolvida (6).
Tipo: Data/hora.
<transaction>
<extraAmount>
Valor extra.
Informa um valor extra que foi somado ou subtrado do valor pago pelo
comprador. Este valor especificado por voc no pagamento e pode
representar um valor que voc quer cobrar separadamente do
comprador ou um desconto que quer dar a ele.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto (.).
Por exemplo, 1234.56 ou -1234.56.
<transaction>
<installmentCount>
Nmero de parcelas.
Indica o nmero de parcelas que o comprador escolheu no pagamento
com carto de crdito.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<itemCount>
Nmero de itens da transao.

Aponta o nmero de itens contidos nesta transao.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<items>
<transaction>
<items>
<item>
VERSO 1.0.3
Lista de itens contidos na transao. O nmero de itens sob este

elemento corresponde ao valor de itemCount.
Representa um item da transao.
36
CAMPO
<transaction>
<items>
<item>
<id>
DESCRIO
Identificador do item.
Identifica o item da transao. Este identificador deve ser nico por
transao e foi informado por voc no fluxo de pagamento.
Tipo: Texto.
Formato: Livre.
<transaction>
<items>
<item>
<description>
Descrio do item.
Descreve o item da transao. A descrio um texto explicativo do
item que voc especificou no fluxo de pagamento.
Tipo: Texto.
Formato: Livre.
<transaction>
<items>
<item>
<amount>
Valor unitrio do item.

Informa o preo unitrio do item da transao. Este o valor que foi
especificado no fluxo de pagamento.
Tipo: Nmero.
1234.56).
<transaction>
<items>
<item>
<quantity>
Quantidade do item.
Informa a quantidade do item da transao. Est a quantidade que
foi especificada no fluxo de pagamento.
Tipo: Nmero.
Formato: Um nmero inteiro maior ou igual a 1 e menor ou igual a 999.
<transaction>
<sender>
<transaction>
<sender>
<email>
Dados do comprador.
E-mail do comprador.
Informa o e-mail do comprador que realizou a transao.
Tipo: Texto.
VERSO 1.0.3
37
CAMPO
DESCRIO
Formato: um e-mail vlido (p.e., usuario@site.com.br), com no
mximo 60 caracteres.
<transaction>
<sender>
<name>
Nome completo do comprador.

Informa o nome completo do comprador que realizou o pagamento.
Presena: Opcional.
Tipo: Texto.
Formato: No mnimo duas sequncias de caracteres, com o limite total
de 50 caracteres.
<transaction>
<sender>
<phone>
<transaction>
<sender>
<phone>
<areaCode>
Dados do telefone do comprador.
DDD do comprador.
Informa o cdigo de rea (DDD) do comprador que realizou o
pagamento.
Presena: Opcional.
Tipo: Nmero.
<transaction>
<sender>
<phone>
<number>
Nmero de telefone do comprador.

Informa o nmero do telefone do comprador que realizou o
pagamento.
Presena: Opcional.
Tipo: Nmero.
Formato: Um nmero de 7 a 9 dgitos.
<transaction>
<shipping>
<transaction>
<shipping>
<type>
VERSO 1.0.3
Dados do frete.
Tipo de frete.
Informa o tipo de frete a ser usado para o envio do produto. A tabela
abaixo informa os valores possveis e seus significados.
Cdigo
Significado
Encomenda normal (PAC).
SEDEX.
Tipo de frete no especificado.
38
CAMPO
DESCRIO
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<shipping>
<cost>
Custo total do frete.

Informa o custo total do frete, a partir das opes de frete informadas
no fluxo de pagamento.
Tipo: Nmero.
1234.56).
<transaction>
<shipping>
<address>
<transaction>
<shipping>
<address>
<country>
<transaction>
<shipping>
<address>
<state>
Dados do endereo de envio.
Pas do endereo de envio.

Informa o pas do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: No momento, apenas o valor BRA permitido.
Estado do endereo de envio.

Informa o estado do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
correspondente.
<transaction>
<shipping>
<address>
<city>
Cidade do endereo de envio.
<transaction>
<shipping>
<address>
<postalCode>
CEP do endereo de envio.
VERSO 1.0.3
Informa a cidade do endereo de envio do produto.

Presena: Opcional.
Tipo: Texto.
Formato: Livre. Deve ser um nome vlido de cidade do Brasil, de
acordo com os dados dos Correios.
Informa o CEP do endereo de envio do produto.
39
CAMPO
DESCRIO
Presena: Opcional.
Tipo: Nmero.
Formato: Um nmero de 8 dgitos.
<transaction>
<shipping>
<address>
<district>
<transaction>
<shipping>
<address>
<street>
<transaction>
<shipping>
<address>
<number>
<transaction>
<shipping>
<address>
<complement>
Bairro do endereo de envio.

Informa o bairro do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
Nome da rua do endereo de envio.
Informa o nome da rua do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
Nmero do endereo de envio.
Informa o nmero do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
Complemento do endereo de envio.
Informa o complemento (bloco, apartamento, etc.) do endereo de
envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
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.
VERSO 1.0.3
40
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:
CDIGO
5003
DESCRIO
Falha de comunicao com a instituio financeira {Nome do Banco}.
10000
invalid creditcard brand.
10001
creditcard number with invalid length.
10002
invalid date format.
10003
invalid security field.
10004
cvv is mandatory.
10006
security field with invalid length.
53004
items invalid quantity.
53005
currency is required.
53006
currency invalid value: {0}
53007
reference invalid length: {0}
53008
notificationURL invalid length: {0}
53009
notificationURL invalid value: {0}
53010
sender email is required.
53011
sender email invalid length: {0}
53012
sender email invalid value: {0}
53013
sender name is required.
53014
sender name invalid length: {0}
53015
sender name invalid value: {0}
53017
sender cpf invalid value: {0}
VERSO 1.0.3
41
CDIGO
DESCRIO
53018
sender area code is required.
53019
sender area code invalid value: {0}
53020
sender phone is required.
53021
sender phone invalid value: {0}
53022
shipping address postal code is required.
53023
shipping address postal code invalid value: {0}
53024
shipping address street is required.
53025
shipping address street invalid length: {0}
53026
shipping address number is required.
53027
shipping address number invalid length: {0}
53028
shipping address complement invalid length: {0}
53029
shipping address district is required.
53030
shipping address district invalid length: {0}
53031
shipping address city is required.
53032
shipping address city invalid length: {0}
53033
shipping address state is required.
53034
shipping address state invalid value: {0}
53035
shipping address country is required.
53036
shipping address country invalid length: {0}
53037
credit card token is required.
53038
installment quantity is required.
53039
installment quantity invalid value: {0}
53040
installment value is required.
53041
installment value invalid value: {0}
53042
credit card holder name is required.
VERSO 1.0.3
42
CDIGO
DESCRIO
53043
credit card holder name invalid length: {0}
53044
credit card holder name invalid value: {0}
53045
credit card holder cpf is required.
53046
credit card holder cpf invalid value: {0}
53047
credit card holder birthdate is required.
53048
credit card holder birthdate invalid value: {0}
53049
credit card holder area code is required.
53050
credit card holder area code invalid value: {0}
53051
credit card holder phone is required.
53052
credit card holder phone invalid value: {0}
53053
billing address postal code is required.
53054
billing address postal code invalid value: {0}
53055
billing address street is required.
53056
billing address street invalid length: {0}
53057
billing address number is required.
53058
billing address number invalid length: {0}
53059
billing address complement invalid length: {0}
53060
billing address district is required.
53061
billing address district invalid length: {0}
53062
billing address city is required.
53063
billing address city invalid length: {0}
53064
billing address state is required.
53065
billing address state invalid value: {0}
53066
billing address country is required.
53067
billing address country invalid length: {0}
VERSO 1.0.3
43
CDIGO
DESCRIO
53068
receiver email invalid length: {0}
53069
receiver email invalid value: {0}
53070
item id is required.
53071
item id invalid length: {0}
53072
item description is required.
53073
item description invalid length: {0}
53074
item quantity is required.
53075
item quantity out of range: {0}
53076
item quantity invalid value: {0}
53077
item amount is required.
53078
item amount invalid pattern: {0}. Must fit the patern: \\d+.\\d\{2\}
53079
item amount out of range: {0}
53081
sender is related to receiver.
53084
invalid receiver: {0}, verify receiver's account status and if it is a seller's account.
53085
payment method unavailable.
53086
cart total amount out of range: {0}
53087
invalid credit card data.
53091
sender hash invalid.
53092
credit card brand is not accepted.
53095
shipping type invalid pattern: {0}
53096
shipping cost invalid pattern: {0}
53097
shipping cost out of range: {0}
53098
cart total value is negative: {0}
53099
extra amount invalid pattern: {0}. Must fit the patern: -?\\d+.\\d\{2\}
53101
payment mode invalid value, valid values are default and gateway.
VERSO 1.0.3
44
CDIGO
DESCRIO
53102
payment method invalid value, valid values are creditCard, boleto e eft.
53104
shipping cost was provided, shipping address must be complete.
53105
sender information was provided, email must be provided too.
53106
credit card holder is incomplete.
53109
shipping address information was provided, sender email must be provided too.
53110
eft bank is required.
53111
eft bank is not accepted.
53115
sender born date invalid value: {0}
53117
sender cnpj invalid value: {0}
53122
sender email invalid domain: {0}. You must use an email @sandbox.pagseguro.com.br
53140
installment quantity out of range: {0}. The value must be greater than zero.
53141
sender is blocked.
53142
credit card token invalid.
Anexos
Exemplo de chamada para Boleto
1. <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
2. <payment>
3.
<mode>default</mode>
4.
<method>boleto</method>
5.
<sender>
6.
<name>Fulano Silva</name>
7.
<email>fulano.silva@uol.com.br</email>
8.
<phone>
9.
10.
11.
</phone>
12.
<documents>
13.
<document>
14.
<type>CPF</type>
15.
<value>11475714734</value>
16.
</document>
17.
</documents>
18.
<hash>abc1234</hash>
VERSO 1.0.3
19.
</sender>
20.
<currency>BRL</currency>
21.
<notificationURL>https://sualoja.com.br/notificacao</notificationURL>
22.
<items>
23.
<item>
24.
<id>1</id>
25.
<description>Descricao do item a ser vendido</description>
26.
27.
28.
</item>
29.
</items>
30.
31.
<reference>R123456</reference>
32.
<shipping>
33.
<address>
34.
<street>Av. Brigadeiro Faria Lima</street>
35.
36.
<complement>1 andar</complement>
37.
38.
39.
<state>SP</state>
40.
41.
42.
</address>
43.
<type>3</type>
44.
<cost>0.00</cost>
45.
</shipping>
46. </payment>
VERSO 1.0.3
45
Exemplo de chamada para Dbito

48. <payment>
49.
50.
<method>eft</method>
51.
<bank>
52.
<name>itau</name>
53.
</bank>
54.
<sender>
55.
56.
57.
<phone>
58.
59.
60.
</phone>
61.
<documents>
62.
<document>
63.
<type>CPF</type>
64.
<value>11475714734</value>
65.
</document>
66.
</documents>
67.
68.
</sender>
69.
70.
71.
<items>
72.
<item>
73.
<id>1</id>
74.
75.
76.
77.
</item>
78.
</items>
79.
80.
81.
<shipping>
82.
<address>
83.
84.
85.
86.
87.
88.
<state>SP</state>
89.
90.
91.
</address>
92.
<type>3</type>
93.
<cost>0.00</cost>
94.
</shipping>
95. </payment>
VERSO 1.0.3
46
47
Exemplo de chamada para Carto de Crdito

97. <payment>
98.
99.
<method>creditCard</method>
100.
<sender>
101.
102.
103.
<phone>
104.
105.
106.
</phone>
107.
<documents>
108.
<document>
109.
<type>CPF</type>
110.
<value>11475714734</value>
111.
</document>
112.
</documents>
113.
114.
</sender>
115.
116.
117.
<items>
118.
<item>
119.
<id>1</id>
120.
121.
122.
123.
</item>
124.
</items>
125.
126.
127.
<shipping>
128.
<address>
129.
130.
131.
132.
133.
134.
<state>SP</state>
135.
136.
137.
</address>
138.
<type>3</type>
139.
<cost>0.00</cost>
140.
</shipping>
141.
<creditCard>
142.
<token>4a56sd456a4d54asd65as4d56a4sd564</token>
143.
<installment>
144.
145.
<value>5.50</value>
146.
</installment>
147.
<holder>
148.
<name>Nome impresso no cartao</name>
149.
<documents>
VERSO 1.0.3
150.
151.
152.
153.
154.
155.
156.
157.
158.
159.
160.
161.
162.
163.
164.
165.
166.
167.
168.
169.
170.
171.
172.
VERSO 1.0.3
<document>
<type>CPF</type>
<value>00722333665</value>
</document>
</documents>
<birthDate>20/10/1980</birthDate>
<phone>
</phone>
</holder>
<billingAddress>
<state>SP</state>
</billingAddress>
</creditCard>
</payment>
48

Pagseguro Checkout Transparente

Enviado por

Dados do documento

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

Pagseguro Checkout Transparente

Enviado por

Direitos autorais:

Formatos disponíveis

Guia de Integrao

O PagSeguro prov todas as ferramentas necessrias para

Iniciando uma sesso de pagamento

Obter identificao do comprador

Obter os meios de pagamento

amount: {valor da transao}

success: {funo de callback para chamadas bem sucedidas},

error: {funo de callback para chamadas que falharam},

complete: {funo de callback para todas chamadas}

//meios de pagamento disponveis

//tratamento comum para todas chamadas

Obter bandeira do carto de crdito

cardBin: {BIN do nmero do carto},

success: {funo de callback para chamadas bem sucedidas},

error: {funo de callback para chamadas que falharam},

complete: {funo de callback para todas chamadas}

//tratamento comum para todas chamadas

Obter token do carto de crdito

cvv: {cdigo de segurana},

expirationMonth: {ms de expirao},

expirationYear: {ano de expirao},

success: {funo de callback para chamadas bem sucedidas},

error: {funo de callback para chamadas que falharam},

complete: {funo de callback para todas chamadas}

//tratamento comum para todas chamadas

Obter opes de parcelamento

amount: {valor do pagamento},

maxInstallmentNoInterest: {quantidade de parcelas sem juros},

brand: {bandeira do carto},

success: {funo de callback para chamadas bem sucedidas},

error: {funo de callback para chamadas que falharam},

complete: {funo de callback para todas chamadas}

//opes de parcelamento disponvel

//tratamento comum para todas chamadas

API do Checkout Transparente

O cabealho Content-Type deve ser informado como no exemplo abaixo:

Exemplo de chamada para Boleto

Exemplo de chamada para Dbito

Os parmetros em XML desta chamada esto disponveis no anexo desta documentao.

Exemplo de chamada para Carto de Crdito

Os parmetros em XML desta chamada esto disponveis no anexo desta documentao.

Retorno da API do Checkout Transparente

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>

<message>shipping address city is required.</message>

Ateno: A pgina do banco no deve ser aberta em um IFrame.

Especifica o e-mail associado conta PagSeguro que est realizando a requisio.

Especifica o token correspondente conta PagSeguro que est realizando a

Parmetros da API do Checkout Transparente

Identificadores dos itens.

Nome completo do comprador.

Especifica o e-mail do comprador que est realizando o pagamento.

Especifica o nome completo do comprador que est realizando o

Lista de documentos do comprador.

Representa um documento do comprador.

Tipo de documento do comprador.

Identificador do vendedor (fingerprint) gerado pelo JavaScript do PagSeguro

Dados do endereo de envio

Pas do endereo de envio.

Estado do endereo de envio.

Cidade do endereo de envio.

Informa o pas do endereo de envio do produto.

Informa o estado do endereo de envio do produto.

Informa a cidade do endereo de envio do produto.

CEP do endereo de envio.