Você está na página 1de 37

GUIA DE INTEGRAO PAGAMENTO DIRETO 1

VERSO 1.0.2











Guia de Integrao
Pagamento Direto











GUIA DE INTEGRAO PAGAMENTO DIRETO 2


VERSO 1.0.2
Histrico de Verses

DATA DESCRIO
26/02/2013 Viso Geral
13/09/2013 Reviso
14/09/2013 Reviso



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 em uma
forma de facilitar e monitorar a execuo das transaes de comrcio eletrnico por meio da
gesto de pagamentos. Qualquer transao efetuada via PagSeguro est sujeita e deve estar
em conformidade com as leis da Repblica Federativa do Brasil.
Aconselhamos que os termos e condies sejam lidos 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 alterao a quaisquer informaes aqui contidas sem aviso prvio.


GUIA DE INTEGRAO PAGAMENTO DIRETO 3


VERSO 1.0.2
ndice
Histrico de Verses .......................................................................................... 2
Copyright ............................................................................................................ 2
Aviso Legal ......................................................................................................... 2
ndice .................................................................................................................. 3
Viso Geral......................................................................................................... 4
Autenticao nas APIs do PagSeguro ............................................................... 4
Autenticao Para Vendedores ................................................................................. 4
Autenticao Para Aplicaes ................................................................................... 4
Pagamento Direto .............................................................................................. 5
Integrao ................................................................................................................ 5
Iniciar sesso de pagamento ..................................................................................... 6
Integraes no browser ............................................................................................ 6
Obter identificao do comprador ........................................................................... 7
Obter bandeira do carto de crdito........................................................................ 7
Obter token do carto de crdito ............................................................................. 8
Obter opes de parcelamento ................................................................................ 9
API de Pagamento Direto ................................................................................. 10
Parmentros da API de Pagamento Direto .............................................................. 13
Retorno da API de Pagamento Direto .............................................................. 24
Parmetros de retorno da API de Pagamento Direto ............................................... 26

GUIA DE INTEGRAO PAGAMENTO DIRETO 4


VERSO 1.0.2
Viso Geral
Este documento descreve o processo de integrao com o pagamento direto do PagSeguro.
Integrando seu sistema de comrcio eletrnico com o pagamento direto do PagSeguro voc
pode oferecer toda a segurana e comodidade do PagSeguro para os seus clientes no
momento da compra, sem precisar sair do seu site ou e-commerce. Com ele possvel
disponibilizar em seu site os meios de pagamento Carto de Crdito, Dbito Online e Boleto,
ou apenas um deles, fica a seu critrio.

O Pagamento Direto do PagSeguro est disponvel para contas do tipo Vendedor e Empresarial.
As sees seguintes indicaro como possvel integrar seu sistema de pagamentos ao
pagamento direto do PagSeguro.


Autenticao nas APIs do PagSeguro
Todas as chamadas s APIs do domnio ws.pagseguro.uol.com.br necessitam de autenticao.
A autenticao pode ser feita tanto por um vendedor quanto por uma aplicao.
Os seguintes parmetros HTTP devem ser passados em todas as chamadas dos servios do
domnio citado.


Autenticao Para Vendedores
Se voc est criando vendas para a sua prpria loja, ento deve utilizar esse tipo de
autenticao.

PARMETRO HTTP DESCRIO
Email
E-mail do vendedor

Presena: Obrigatrio.
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.
token
Token do Vendedor

Presena: Obrigatrio.
Tipo: Texto.
Exemplo: 861D0B48DBA3485AB2E36675332F2812



Autenticao Para Aplicaes
Se voc uma plataforma ou uma aplicao e est integrando vrias lojas com o Modelo de
Aplicaes do PagSeguro, ento deve utilizar esse tipo de autenticao.

GUIA DE INTEGRAO PAGAMENTO DIRETO 5


VERSO 1.0.2
PARMETRO HTTP DESCRIO
appId
ID da Aplicao.

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

Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
Exemplo: 861D0B48DBA3485AB2E36675332F2812
authorizationCode
Cdigo que autoriza a aplicao o em suas aes em nome do
vendedor

Presena: Obrigatrio.
Tipo: Texto.
Exemplo: 5A220D39B3B31E8BB4E3EFA4FCC4E6L5


Pagamento Direto
A API de pagamento direto 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.

Para fazer essa integrao o PagSeguro criou alguns servios que juntos possibilitam construir
um checkout integrado, seguro e invisvel para o comprador.

Integrao
Para fazer a integrao do Pagamento Direto, voc precisa seguir os seguintes passos:

Iniciar sesso 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 identificao do comprador (Todos os meios de pagamento)
Efetuar o pagamento utilizando a API de pagamento direto (Todos os meios de
pagamento)

GUIA DE INTEGRAO PAGAMENTO DIRETO 6


VERSO 1.0.2
Iniciar sesso de pagamento
Para iniciar um pagamento direto necessrio ter um ID de sesso vlido. Este servio retorna
o ID de sesso que ser usado nas chamadas JavaScript.

A explicao vlida tanto para a chamada por parmetros HTTP quanto para a chamada por
formato XML.

Esta API requer a autenticao descrita na pgina 4.

URL:
HttpMethod: POST
https://ws.pagseguro.uol.com.br/v2/sessions

Retorno:
1. <?xml version="1.0" encoding="ISO-8859-1"?>
2. <session>
3. <id>620f99e348c24f07877c927b353e49d3</id>
4. </session>
Integraes no browser

A API de pagamento direto possui algumas funes JavaScript para algumas operaes que
devem ser executadas no browser do cliente, funes que sero descritas mais adiante. E para
essas funes existe uma API JavaScript que deve ser importada no final da pgina dos meios
de pagamento:

<script type="text/javascript"
src="https://stc.pagseguro.uol.com.br/pagseguro/api/v2/checkout/pagseguro.directpayme
nt.js"></script>
<script type="text/javascript">
PagSeguroDirectPayment.setSessionId('ID DE SESSO GERADO NA PGINA 5);
</script>


Esse JavaScript possui um objeto chamado PagSeguroDirectPayment, que a interface de
acesso aos mtodos. Repare que logo depois de importar o arquivo, deve ser executado
mtodo setSessionId com o ID de sesso descrito na pgina 5.

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 das funes. Sendo que 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.


GUIA DE INTEGRAO PAGAMENTO DIRETO 7


VERSO 1.0.2
Obter identificao do comprador

Para realizar o pagamento direto, necessrio enviar um identificador do comprador gerado
pelo JavaScript. um mtodo simples chamado getSenderHash que no possui parmetros e
retorna esse identificador. Esse identificador obrigatrio mesmo para pagamento direto com
boleto ou dbito online.

Sintaxe:
PagSeguroDirectPayment.getSenderHash();
Obter bandeira do carto de crdito

Esse processo utilizado apenas para o meio de pagamento carto de crdito. Ele ser
utilizado para verificar qual a bandeira do carto que est sendo digitado, existe o mtodo
getBrand, esse mtodo recebe por parmetro o bin do carto (primeiros 6 dgitos) e retorna
dados da bandeira para aquele BIN 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:
PagSeguroDirectPayment.getBrand({
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}
});


Exemplo:
PagSeguroDirectPayment.getBrand({
cardBin: $("input#cartao").val(),
success: function(response) {
//bandeira encontrada
},
error: function(response) {
//tratamento do erro
},
complete: function(response) {
//tratamento comum para todas chamadas
}

});

Retorno:
{
"brand":{
"name":"visa",
"bin":411111,
"cvvSize":3,
"expirable":true,
"validationAlgorithm":"LUHN"
}
}



GUIA DE INTEGRAO PAGAMENTO DIRETO 8


VERSO 1.0.2
Obter token do carto de crdito

Esse processo necessrio apenas para o meio de pagamento carto de crdito. Esse servio
retorna o token que representa o carto que ser usado na API de pagamento direto.

A chamada desse servio obrigatria para uso da API de pagamento com carto de crdito e
o mtodo createCardToken. Ele recebe os dados do carto que so: nmero (obrigatrio),
cvv (opcional para alguns cartes), data de expirao (opcional para alguns cartes) e a
bandeira (opcional para qualquer chamada).

Sintaxe:
PagSeguroDirectPayment.createCardToken({
cardNumber: {nmero},
brand: {bandeira},
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}
});


Exemplo:
var param = {
cardNumber: $("input#cartao").val(),
cvv: $("input#cvv").val(),
expirationMonth: $("input#validadeMes").val(),
expirationYear: $("input#validadeAno").val(),
success: function(response) {
//token gerado, esse deve ser usado na chamada da API de pagamento direto
},
error: function(response) {
//tratamento do erro
},
complete: function(response) {
//tratamento comum para todas chamadas
}
}

//parmetro opcional para qualquer chamada
if($("input#bandeira").val() != '') {
param.brand = $("input#bandeira").val();
}

PagSeguroDirectPayment.createCardToken(param);

Retorno:
{
"card":{
"token":"653fe9044cf149f9b7db562431cb130d"
}
}



GUIA DE INTEGRAO PAGAMENTO DIRETO 9


VERSO 1.0.2
Obter opes de parcelamento

Esse processo utilizado apenas para o meio de pagamento carto de crdito. Caso voc
queira mostrar opes de parcelamento para o comprador, existe o mtodo getInstallments.
Esse servio recebe o valor a ser parcelado (obrigatrio) e a bandeira que se deseja obter o
parcelamento (opcional, se no informada retorna os dados para todas bandeiras aceitas pelo
PagSeguro).
No retorno informado para cada bandeira, as configuraes de cada parcela: novo valor total
do pagamento (que deve ser enviado junto na API de pagamento), valor e quantidade da
parcela (que tambm devem ser informados na API de pagamento) e um indicador se aquela
parcela tem juros ou no (para o caso do vendedor ter configurado promoo no PagSeguro)

Sintaxe:
PagSeguroDirectPayment.getInstallments({
amount: {valor do pagamento},
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}
});

Exemplo:
PagSeguroDirectPayment.getInstallments({
amount: $("input#valorPagto").val(),
brand: $("input#bandeira").val(),
success: function(response) {
//opes de parcelamento disponvel
},
error: function(response) {
//tratamento do erro
},
complete: function(response) {
//tratamento comum para todas chamadas
}
});

Retorno:
{
"error":false,
"installments":{
"visa":[
{
"quantity":1,
"totalAmount":16,
"installmentAmount":16,
"interestFree":true
},{
"quantity":2,
"totalAmount":16.48,
"installmentAmount":8.24,
"interestFree":false
},{
"quantity":3,
"totalAmount":16.64,
"installmentAmount":5.55,
"interestFree":false
}
]
}
}

GUIA DE INTEGRAO PAGAMENTO DIRETO 10


VERSO 1.0.2

API de Pagamento Direto

Por fim, este servio envia os dados do comprador e do pagamento para realizar a cobrana.

URL:
HttpMethod: POST
https://ws.pagseguro.uol.com.br/v2/transactions


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.

Veja abaixo um exemplo completo de uma requisio para a API de Pagamentos do PagSeguro
informando os dados do pagamento em parmetros HTTP (as linhas foram quebradas para
facilitar a leitura).

curl https://ws.pagseguro.uol.com.br/v2/transactions/ -d\
"email=suporte@lojamodelo.com.br\
&token=95112EE828D94278BD394E91C4388F20\
&paymentMode=default\
&paymentMethod=creditCard\
&receiverEmail=suporte@lojamodelo.com.br\
&currency=BRL\
&extraAmount=1.00
&itemId1=0001\
&itemDescription1=Notebook Prata\
&itemAmount1=24300.00\
&itemQuantity1=1\
&itemId2=0002\
&itemDescription2=Notebook Rosa\
&itemAmount2=25600.00\
&itemQuantity2=2\
&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
&creditCardToken=4as56d4a56d456as456dsa\
&installmentQuantity=5\
&installmentValue=125.22\
GUIA DE INTEGRAO PAGAMENTO DIRETO 11


VERSO 1.0.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\"



GUIA DE INTEGRAO PAGAMENTO DIRETO 12


VERSO 1.0.2
O exemplo abaixo mostra um exemplo em XML que faz um Pagamento Direto.

1. <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
2. <payment>
3. <mode>default</mode>
4. <method>creditCard</method>
5. <sender>
6. <name>Fulano Silva</name>
7. <email>fulano.silva@uol.com.br</email>
8. <phone>
9. <areaCode>11</areaCode>
10. <number>30380000</number>
11. </phone>
12. <documents>
13. <document>
14. <type>CPF</type>
15. <value>11475714734</value>
16. </document>
17. </documents>
18. <hash>abc1234</hash>
19. </sender>
20. <currency>BRL</currency>
21. <notificationURL>https://sualoja.com.br/notifica.html</notificationURL>
22. <items>
23. <item>
24. <id>1</id>
25. <description>Descricao do item a ser vendido</description>
26. <quantity>2</quantity>
27. <amount>1.00</amount>
28. </item>
29. <item>
30. <id>2</id>
31. <description>Descrio do item a ser vendido</description>
32. <quantity>2</quantity>
33. <amount>1.00</amount>
34. </item>
35. <item>
36. <id>3</id>
37. <description>Descrio do item a ser vendido</description>
38. <quantity>2</quantity>
39. <amount>1.00</amount>
40. </item>
41. </items>
42. <extraAmount>0.00</extraAmount>
43. <reference>R123456</reference>
44. <shipping>
45. <address>
46. <street>Av. Brigadeiro Faria Lima</street>
47. <number>1384</number>
48. <complement>1 andar</complement>
49. <district>Jardim Paulistano</district>
50. <city>Sao Paulo</city>
51. <state>SP</state>
52. <country>BRA</country>
53. <postalCode>01452002</postalCode>
54. </address>
GUIA DE INTEGRAO PAGAMENTO DIRETO 13


VERSO 1.0.2
55. <type>3</type>
56. <cost>0.00</cost>
57. </shipping>
58. <creditCard>
59. <token>4a56sd456a4d54asd65as4d56a4sd564</token>
60. <installment>
61. <quantity>2</quantity>
62. <value>5.50</value>
63. </installment>
64. <holder>
65. <name>Nome impresso no cartao</name>
66. <documents>
67. <document>
68. <type>CPF</type>
69. <value>00722333665</value>
70. </document>
71. </documents>
72. <birthDate>20/10/1980</birthDate>
73. <phone>
74. <areaCode>11</areaCode>
75. <number>999991111</number>
76. </phone>
77. </holder>
78. <billingAddress>
79. <street>Av. Brigadeiro Faria Lima</street>
80. <number>1384</number>
81. <complement>1 andar</complement>
82. <district>Jardim Paulistano</district>
83. <city>Sao Paulo</city>
84. <state>SP</state>
85. <country>BRA</country>
86. <postalCode>01452002</postalCode>
87. </billingAddress>
88. </creditCard>
89. </payment>
90.

Parmentros da API de Pagamento Direto

A tabela abaixo descreve os parmetros da API de Pagamento Direto. Para a integrao usando
XML o elemento raiz o <payment>.

PARMETRO DESCRIO
Parmetro HTTP:
receiverEmail

Elemento XML:
<payment>
<receiver>
<email>
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.
GUIA DE INTEGRAO PAGAMENTO DIRETO 14


VERSO 1.0.2

Parmetro HTTP:
notificationURL

Elemento XML:
<payment>
<notificationURL>

URL para envio de notificaes.

Presena: Opcional
Tipo: Texto
Formato: Uma URL vlida, com limite de 255 caracteres.
Parmetro HTTP:
currency

Elemento XML:
<payment>
<currency>

Moeda utilizada.
Indica a moeda na qual o pagamento ser feito. No momento, a
nica opo disponvel BRL (Real).
Presena: Obrigatria.
Tipo: Texto.
Formato: Somente o valor BRL aceito.
Parmetro HTTP:
paymentMethod

Elemento XML:
<payment>
<method>

Meio de pagamento

Presena: Obrigatria.
Tipo: Texto.
Formato: creditCard, boleto ou eft.
Parmetro HTTP:
paymentMode

Elemento XML:
<payment>
<mode>

Modo do pagamento

Presena: Opcional (se no informado, assume default).
Tipo: Texto.
Formato: default ou gateway.
Dados do produto
Parmetro HTTP:
itemId1, itemId2, etc.

Elemento XML:
<checkout>
<items>
<item>
<id>

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.
Presena: Obrigatria.
Tipo: Texto.
Formato: Livre, com limite de 100 caracteres.
Parmetro HTTP:
itemDescription1, itemDescription2,
etc.
Descries dos itens.
Descrevem os itens sendo pagos. A descrio o texto que o
GUIA DE INTEGRAO PAGAMENTO DIRETO 15


VERSO 1.0.2

Elemento XML:
<payment>
<items>
<item>
<description>

PagSeguro mostra associado a cada item quando o comprador
est finalizando o pagamento, portanto importante que ela
seja clara e explicativa.
Presena: Obrigatria.
Tipo: Texto.
Formato: Livre, com limite de 100 caracteres.
Parmetro HTTP:
itemAmount1, itemAmount2, etc.

Elemento XML:
<checkout>
<items>
<item>
<amount>

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.
Presena: Obrigatria.
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.
Parmetro HTTP:
itemQuantity1, itemQuantity2, etc.

Elemento XML:
<payment>
<items>
<item>
<quantity>

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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Um nmero inteiro maior ou igual a 1 e menor ou igual
a 999.
Parmetro HTTP:
reference

Elemento XML:
<payment>
<reference>

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.
Parmetro HTTP:
extraAmount

Elemento XML:
<payment>
<extraAmount>

Valores extras a serem cobrados

Presena: Opcional.
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.
GUIA DE INTEGRAO PAGAMENTO DIRETO 16


VERSO 1.0.2
Elemento XML:
<payment>
<sender>

Dados do comprador.
Parmetro HTTP:
senderEmail

Elemento XML:
<payment>
<sender>
<email>

E-mail do comprador.
Especifica o e-mail do comprador que est realizando o
pagamento.
Presena: Obrigatrio.
Tipo: Texto.
Formato: um e-mail vlido (p.e., usuario@site.com.br), com no
mximo 60 caracteres.
Parmetro HTTP:
senderName

Elemento XML:
<payment>
<sender>
<name>

Nome completo do comprador.
Especifica o nome completo do comprador que est realizando o
pagamento.

Presena: Obrigatrio.
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.
Presena: Obrigatrio.
Tipo: Texto.
Formato: Case sensitive. Somente o valor CPF aceito.
GUIA DE INTEGRAO PAGAMENTO DIRETO 17


VERSO 1.0.2
Parmetro HTTP:
senderCPF

Elemento XML:
<payment>
<sender>
<documents>
<document>
<value>

CPF do dono do comprador

Presena: Obrigatrio.
Tipo: Texto.
Formato: Nmero.
Parmetro HTTP:
senderAreaCode

Elemento XML:
<payment>
<sender>
<phone>
<areaCode>

DDD do comprador.
Especifica o cdigo de rea (DDD) do comprador que est
realizando o pagamento.
Presena: Obrigatrio.
Tipo: Nmero.
Formato: Um nmero de 2 dgitos correspondente a um DDD
vlido.
Parmetro HTTP:
senderPhone

Elemento XML:
<payment>
<sender>
<phone>
<number>

Nmero do telefone do comprador.
Especifica o nmero do telefone do comprador que est
realizando o pagamento
Presena: Obrigatrio.
Tipo: Nmero.
Formato: Um nmero de 7 a 9 dgitos.
Parmetro HTTP:
senderHash

Elemento XML:
<payment>
<sender>
<hash>

Identificador do vendedor.
Identificador gerado pela API JavaScript do PagSeguro que
identifica o vendedor (fingerprint)
Presena: Obrigatrio.
Tipo: Texto.
Formato: Obtido a partir de uma chamada javascript
PagseguroDirectPayment.getSenderHash()
Elemento XML:
<payment>
<shipping>

Dados da Entrega
Parmetro HTTP:
shippingType
Forma de envio do produto.

GUIA DE INTEGRAO PAGAMENTO DIRETO 18


VERSO 1.0.2

Elemento XML:
<payment>
<shipping>
<type>

Presena: Opcional.
Tipo: Nmero.
Formato: 1 PAC, 2 SEDEX, 3 - Desconhecido
Parmetro HTTP:
shippingCost

Elemento XML:
<payment>
<shipping>
<cost>

Valor do frete

Presena: Opcional.
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.
Elemento XML:
<payment>
<shipping>
<address>

Dados do endereo de envio
Parmetro HTTP:
shippingAddressCountry

Elemento XML:
<payment>
<shipping>
<address>
<country>

Pas do endereo de envio.
Informa o pas do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Texto.
Formato: No momento, apenas o valor BRA permitido.
Parmetro HTTP:
shippingAddressState

Elemento XML:
<payment>
<shipping>
<address>
<state>

Estado do endereo de envio.
Informa o estado do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Texto.
Formato: Duas letras, representando a sigla do estado brasileiro
correspondente.
Parmetro HTTP:
shippingAddressCity

Elemento XML:
<payment>
Cidade do endereo de envio.
Informa a cidade do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Texto.
GUIA DE INTEGRAO PAGAMENTO DIRETO 19


VERSO 1.0.2
<shipping>
<address>
<city>

Formato: Livre. Deve ser um nome vlido de cidade do Brasil,
com no mnimo 2 e no mximo 60 caracteres.
Parmetro HTTP:
shippingAddressPostalCode

Elemento XML:
<payment>
<shipping>
<address>
<postalCode>

CEP do endereo de envio.
Informa o CEP do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Nmero.
Formato: Um nmero de 8 dgitos.
Parmetro HTTP:
shippingAddressDistrict

Elemento XML:
<payment>
<shipping>
<address>
<district>

Bairro do endereo de envio.
Informa o bairro do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Texto.
Formato: Livre, com limite de 60 caracteres.
Parmetro HTTP:
shippingAddressStreet

Elemento XML:
<payment>
<shipping>
<address>
<street>

Nome da rua do endereo de envio.
Informa o nome da rua do endereo de envio do produto.
Presena: Obrigatrio.
Tipo: Texto.
Formato: Livre, com limite de 80 caracteres.
Parmetro HTTP:
shippingAddressNumber

Elemento XML:
<payment>
<shipping>
<address>
<number>

Nmero do endereo de envio.
Informa o nmero do endereo de envio do produto.

Presena: Obrigatrio.
Tipo: Texto.
Formato: Livre, com limite de 20 caracteres.
Parmetro HTTP:
shippingAddressComplement
Complemento do endereo de envio.
GUIA DE INTEGRAO PAGAMENTO DIRETO 20


VERSO 1.0.2

Elemento XML:
<payment>
<shipping>
<address>
<complement>

Informa o complemento (bloco, apartamento, etc.) do endereo
de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com limite de 40 caracteres.
Dados para Dbito Online
Elemento XML:
<payment>
<bank>
<name>

Dados do banco.
Parmetro HTTP:
bankName

Elemento XML:
<payment>
<bank>
<name>
Nome do Banco

Nome de banco para qual vai ser gerado o link de redirecionamento

Presena: Obrigatrio para Dbito Online.
Tipo: Texto
Formato: bradesco, itau, bancodobrasil, banrisul ou hsbc
Dados do carto
Parmetro HTTP:
creditCardToken

Elemento XML:
<payment>
<creditCard>
<token>
Token do Carto de Crdito

Token retornado no servio descrito na Seo 0
Presena: Obrigatrio para Carto de Crdito
Tipo: Texto
Formato: No tem limite de caracteres
Parmetro HTTP:
installmentQuantity

Elemento XML:
<payment>
<creditCard>
<installment>
<quantity>
Quantidade de parcelas
Quantidade de parcelas obtidas no servio descrito na Seo 0

Presena: Obrigatrio para Carto de Crdito.
Tipo: Inteiro
Valores aceitos: [1, 18]
Parmetro HTTP:
installmentValue

Elemento XML:
<payment>
Valor das parcelas

Valor das parcelas obtidas no descrito na Seo 0

Presena: Obrigatrio para Carto de Crdito.
GUIA DE INTEGRAO PAGAMENTO DIRETO 21


VERSO 1.0.2
<creditCard>
<installment>
<value>
Tipo: Nmero
Formato: Numrico com 2 casas decimais e separado por ponto. Ex:
1111.11
Dados do dono do carto
Parmetro HTTP:
creditCardHolderName

Elemento XML:
<payment>
<creditCard>
<holder>
<name>
Nome impresso no carto de crdito

Presena: Obrigatrio para Carto de Crdito.
Tipo: Texto
Formato: min = 1, max = 50 caracteres
Parmetro HTTP:
creditCardHolderBirthDate

Elemento XML:
<payment>
<creditCard>
<holder>
<birthDate>
Data de nascimento do dono do carto de crdito

Presena: Obrigatrio para 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.

Presena: Obrigatrio para Carto de Crdito.
Tipo: Texto.
Formato: Case sensitive. Somente o valor CPF aceito.
GUIA DE INTEGRAO PAGAMENTO DIRETO 22


VERSO 1.0.2
Parmetro HTTP:
creditCardHolderCPF

Elemento XML:
<payment>
<creditCard>
<holder>
<documents>
<document>
<value>

CPF do dono do carto de crdito

Presena: Obrigatrio para Carto de Crdito.
Tipo: Texto
Elemento XML:
<payment>
<creditCard>
<holder>
<phone>

Telefone do dono do carto de crdito.
Parmetro HTTP:
creditCardHolderAreaCode

Elemento XML:
<payment>
<creditCard>
<holder>
<phone>
<areaCode>


Cdigo de rea

Presena: Obrigatrio para Carto de Crdito.
Tipo: Nmero
Formato: Um nmero de 2 dgitos correspondente a um DDD
vlido.
Parmetro HTTP:
creditCardHolderPhone

Elemento XML:
<payment>
<creditCard>
<holder>
<phone>
<number>








Telefone

Presena: Obrigatrio para Carto de Crdito.
Tipo: Nmero
Formato: Um nmero entre 7 e 9 digitos.
GUIA DE INTEGRAO PAGAMENTO DIRETO 23


VERSO 1.0.2
Dados de endereo de cobrana
Elemento XML:
<payment>
<creditCard>
<billingAddress>

Endereo de cobrana.
Parmetro HTTP:
billingAddressPostalCode

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<postalCode>

CEP do endereo de cobrana

Presena: Obrigatrio para Carto de Crdito.
Formato: Um nmero de 8 dgitos correspondente a um CEP
vlido (p.e, 01452002).
Parmetro HTTP:
billingAddressStreet

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<street>

Nome da Rua

Presena: Obrigatrio para Carto de Crdito.
Formato: Livre
Parmetro HTTP:
billingAddressNumber

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<number>

Nmero

Presena: Obrigatrio para Carto de Crdito.
Formato: Livre
Parmetro HTTP:
billingAddressComplement

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<complement>



Complemento

Presena: Opcional para Carto de Crdito.
Formato: Livre
GUIA DE INTEGRAO PAGAMENTO DIRETO 24


VERSO 1.0.2
Parmetro HTTP:
billingAddressDistrict

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<district>

Bairro

Presena: Obrigatrio para Carto de Crdito.
Tipo: Texto.
Formato: Livre, com limite de 60 caracteres.
Parmetro HTTP:
billingAddressCity

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<city>

Cidade

Presena: Obrigatrio para Carto de Crdito.
Formato: Deve ser um nome vlido de cidade do Brasil, com no
mnimo 2 e no mximo 60 caracteres.
Parmetro HTTP:
billingAddressState

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<state>

Estado

Presena: Obrigatrio para Carto de Crdito.
Formato: Duas letras, representando a sigla do estado brasileiro
correspondente (p.e, SP).
Parmetro HTTP:
billingAddressCountry

Elemento XML:
<payment>
<creditCard>
<billingAddress>
<country>

Pas

Presena: Obrigatrio para Carto de Crdito.
Formato: Reconhece apenas o valor BRA.


Retorno da API de Pagamento Direto
Aps a chamada para a API de Pagamento Direto, retornado um XML com todos os dados da
transao conforme o exemplo abaixo:
1. <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
2. <transaction>
3. <date>2011-02-05T15:46:12.000-02:00</date>
4. <lastEventDate>2011-02-15T17:39:14.000-03:00</lastEventDate>
GUIA DE INTEGRAO PAGAMENTO DIRETO 25


VERSO 1.0.2
5. <code>9E884542-81B3-4419-9A75-BCC6FB495EF1</code>
6. <reference>REF1234</reference>
7. <type>1</type>
8. <status>3</status>
9. <paymentMethod>
10. <type>1</type>
11. <code>101</code>
12. </paymentMethod>
13. <paymentLink>
14. https://pagseguro.uol.com.br/checkout/imprimeBoleto.jhtml?code=314601B208B24A5CA5
3260000F7BB0D0
15. </paymentLink>
16. <grossAmount>49900.00</grossAmount>
17. <discountAmount>0.00</discountAmount>
18. <feeAmount>0.00</feeAmount>
19. <netAmount>49900.50</netAmount>
20. <extraAmount>0.00</extraAmount>
21. <installmentCount>1</installmentCount>
22. <itemCount>2</itemCount>
23. <items>
24. <item>
25. <id>0001</id>
26. <description>Notebook Prata</description>
27. <quantity>1</quantity>
28. <amount>24300.00</amount>
29. </item>
30. <item>
31. <id>0002</id>
32. <description>Notebook Rosa</description>
33. <quantity>1</quantity>
34. <amount>25600.00</amount>
35. </item>
36. </items>
37. <sender>
38. <name>Jos Comprador</name>
39. <email>comprador@uol.com.br</email>
40. <phone>
41. <areaCode>11</areaCode>
42. <number>56273440</number>
43. </phone>
44. </sender>
45. <shipping>
46. <address>
47. <street>Av. Brig. Faria Lima</street>
48. <number>1384</number>
49. <complement>5o andar</complement>
50. <district>Jardim Paulistano</district>
51. <postalCode>01452002</postalCode>
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>
GUIA DE INTEGRAO PAGAMENTO DIRETO 26


VERSO 1.0.2
Parmetros de retorno da API de Pagamento Direto
A tabela abaixo descreve os parmetros de retorno da API de Pagamento Direto.
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.
Presena: Obrigatria.
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.
Presena: Obrigatria.
Tipo: Data/hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C
para datas. Veja mais sobre formatao de datas.
<transaction>
<code>
Cdigo identificador da transao
Retorna o cdigo que identifica a transao de forma nica.
Presena: Obrigatria.
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.
GUIA DE INTEGRAO PAGAMENTO DIRETO 27


VERSO 1.0.2
CAMPO DESCRIO
Cdigo Significado
1
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.
Presena: Obrigatria.
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.
Cdigo Significado
1
Aguardando pagamento: o comprador iniciou a
transao, mas at o momento o PagSeguro no
recebeu nenhuma informao sobre o pagamento.
2
Em anlise: o comprador optou por pagar com um
carto de crdito e o PagSeguro est analisando o risco
da transao.
3
Paga: a transao foi paga pelo comprador e o
PagSeguro j recebeu uma confirmao da instituio
financeira responsvel pelo processamento.
4
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.
5
Em disputa: o comprador, dentro do prazo de liberao
da transao, abriu uma disputa.
6
Devolvida: o valor da transao foi devolvido para o
comprador.
7
Cancelada: a transao foi cancelada sem ter sido
finalizada.
Outros status menos relevantes foram omitidos. Em resumo, voc
GUIA DE INTEGRAO PAGAMENTO DIRETO 28


VERSO 1.0.2
CAMPO DESCRIO
deve considerar transaes nos status de Paga para liberao de
produtos ou servios.
Presena: Obrigatria.
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.
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>
Dados do meio de pagamento usado pelo comprador.
<transaction>
<paymentMethod>
<type>
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
1
Carto de crdito: o comprador escolheu pagar a
transao com carto de crdito.
2
Boleto: o comprador optou por pagar com um boleto
bancrio.
3
Dbito online (TEF): o comprador optou por pagar a
transao com dbito online de algum dos bancos
conveniados.
4
Saldo PagSeguro: o comprador optou por pagar a
transao utilizando o saldo de sua conta PagSeguro.
GUIA DE INTEGRAO PAGAMENTO DIRETO 29


VERSO 1.0.2
CAMPO DESCRIO
5
Oi Paggo *: o comprador escolheu pagar sua transao
atravs de seu celular Oi.
7
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.
* Os tipos marcados no esto disponveis para utilizao.
Presena: Obrigatria.
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>
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.
GUIA DE INTEGRAO PAGAMENTO DIRETO 30


VERSO 1.0.2
CAMPO DESCRIO
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.
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. *
GUIA DE INTEGRAO PAGAMENTO DIRETO 31


VERSO 1.0.2
CAMPO DESCRIO
701 Depsito em conta - Banco do Brasil
* Os meios de pagamento marcados no esto disponveis para
utilizao.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<grossAmount>
Valor bruto da transao.
Informa o valor bruto da transao, calculado pela soma dos preos
de todos os itens presentes no pagamento.
Presena: Obrigatria.
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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto
("."). Por exemplo, 1234.56.
<transaction>
<feeAmount>
Valor total das taxas cobradas.
Informa o valor total das taxas cobradas pelo PagSeguro nesta
transao.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto
("."). Por exemplo, 1234.56.
<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
GUIA DE INTEGRAO PAGAMENTO DIRETO 32


VERSO 1.0.2
CAMPO DESCRIO
extraAmount (que pode ser positivo ou negativo) tambm
considerado no clculo.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto
("."). Por exemplo, 1234.56.
<transaction>
<escrowEndDate>
Data de crdito.
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.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C
para datas. Veja mais sobre formatao de datas.
<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.
Presena: Obrigatria.
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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Inteiro.
<transaction>
<itemCount>
Nmero de itens da transao.
Aponta o nmero de itens contidos nesta transao.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Inteiro.
GUIA DE INTEGRAO PAGAMENTO DIRETO 33


VERSO 1.0.2
CAMPO DESCRIO
<transaction>
<items>
Lista de itens contidos na transao. O nmero de itens sob este
elemento corresponde ao valor de itemCount.
<transaction>
<items>
<item>
Representa um item da transao.
<transaction>
<items>
<item>
<id>
Identificador do item.
Identifica o item da transao. Este identificador deve ser nico por
transao e foi informado por voc no fluxo de pagamento.
Presena: Obrigatria.
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.
Presena: Obrigatria.
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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto
(p.e., 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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Um nmero inteiro maior ou igual a 1 e menor ou igual a
999.
GUIA DE INTEGRAO PAGAMENTO DIRETO 34


VERSO 1.0.2
CAMPO DESCRIO
<transaction>
<sender>
Dados do comprador.
<transaction>
<sender>
<email>
E-mail do comprador.
Informa o e-mail do comprador que realizou a transao.
Presena: Obrigatria.
Tipo: Texto.
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>
Dados do telefone do comprador.
<transaction>
<sender>
<phone>
<areaCode>
DDD do comprador.
Informa o cdigo de rea (DDD) do comprador que realizou o
pagamento.
Presena: Opcional.
Tipo: Nmero.
Formato: Um nmero de 2 dgitos correspondente a um DDD vlido.
<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>
Dados do frete.
GUIA DE INTEGRAO PAGAMENTO DIRETO 35


VERSO 1.0.2
CAMPO DESCRIO
<transaction>
<shipping>
<type>
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
1 Encomenda normal (PAC).
2 SEDEX.
3 Tipo de frete no especificado.
Presena: Obrigatria.
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.
Presena: Obrigatria.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto
(p.e., 1234.56).
<transaction>
<shipping>
<address>
Dados do endereo de envio.
<transaction>
<shipping>
<address>
<country>
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.
<transaction>
<shipping>
<address>
<state>
Estado do endereo de envio.
Informa o estado do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Duas letras, representando a sigla do estado brasileiro
correspondente.
GUIA DE INTEGRAO PAGAMENTO DIRETO 36


VERSO 1.0.2
CAMPO DESCRIO
<transaction>
<shipping>
<address>
<city>
Cidade do endereo de envio.
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.
<transaction>
<shipping>
<address>
<postalCode>
CEP do endereo de envio.
Informa o CEP do endereo de envio do produto.
Presena: Opcional.
Tipo: Nmero.
Formato: Um nmero de 8 dgitos.
<transaction>
<shipping>
<address>
<district>
Bairro do endereo de envio.
Informa o bairro do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
<transaction>
<shipping>
<address>
<street>
Nome da rua do endereo de envio.
Informa o nome da rua do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
<transaction>
<shipping>
<address>
<number>
Nmero do endereo de envio.
Informa o nmero do endereo de envio do produto.
Presena: Opcional.
Tipo: Texto.
Formato: Livre.
<transaction>
<shipping>
<address>
<complement>
Complemento do endereo de envio.
Informa o complemento (bloco, apartamento, etc.) do endereo de
envio do produto.
Presena: Opcional.
Tipo: Texto.
GUIA DE INTEGRAO PAGAMENTO DIRETO 37


VERSO 1.0.2
CAMPO DESCRIO
Formato: Livre.

Você também pode gostar