Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Assinatura Automtica
Histrico de Verses
DATA
09/04/2012
17/06/2014
DESCRIO
Viso Geral
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 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.0
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.0
ndice
Histrico de Verses ...................................................................................................................... 2
Copyright ....................................................................................................................................... 2
Aviso Legal ..................................................................................................................................... 2
ndice ............................................................................................................................................. 4
Viso Geral..................................................................................................................................... 6
Etapas da Integrao ..................................................................................................................... 6
Autorizao.................................................................................................................................... 6
Assinatura com cobrana automtica .................................................................................. 7
Requisio de Assinatura Automtica ........................................................................................... 8
Informando os dados em parmetros HTTP ......................................................................... 8
Informando os dados em formato XML................................................................................ 9
Resposta do servio de Assinatura ..................................................................................... 10
Direcionando o comprador para o fluxo de autorizao .................................................... 11
Notificao................................................................................................................................... 11
Notificao de assinatura ................................................................................................... 12
Notificao de transao .................................................................................................... 12
Consulta de assinaturas ............................................................................................................... 13
Consultando pelo cdigo de notificao ............................................................................ 13
Consultando pelo cdigo da assinatura .............................................................................. 13
Consultando por intervalo de dias...................................................................................... 14
Consultando por intervalo de data ..................................................................................... 14
Consulta de transaes ............................................................................................................... 15
Cancelando uma assinatura ........................................................................................................ 16
Listagem de Parmetros .............................................................................................................. 16
Autenticao ....................................................................................................................... 16
Requisio ........................................................................................................................... 17
VERSO 1.0.0
VERSO 1.0.0
Viso Geral
O modelo de assinaturas do PagSeguro permite que sua empresa oferea aos seus compradores servios
com pagamentos recorrentes de forma fcil e segura. Seja uma assinatura de revista, mensalidade de um
curso, contedo exclusivo ou qualquer modelo que necessite de uma cobrana recorrente, o modelo de
assinaturas proporciona uma forma completa de criar cobranas no presenciais previamente autorizadas
pelo comprador, maximizando assim a fidelizao.
O modelo de assinaturas est disponvel apenas para contas do tipo Vendedor e Empresarial e aceita apenas
pagamentos com carto de crdito.
Etapas da Integrao
A integrao da assinatura automtica possui algumas etapas bsicas:
1. Autorizao
2. Notificao
3. Consulta e Cancelamento
Autorizao
A autorizao o processo onde o cliente, aps escolher o servio no site redirecionado para o PagSeguro
para efetuar a autorizao de dbito recorrente em seu carto de crdito. Veja a representao do fluxo na
Imagem 1.
Imagem 1
A imagem anterior representa o fluxo na viso do comprador, ou seja, do cliente que acessa a sua loja.
VERSO 1.0.0
Na viso do desenvolvedor, temos uma requisio para a API de Assinatura, demonstrada na Imagem 2.
Imagem 2
A loja faz uma chamada para o servio de Requisio de Assinatura passando todos os parmetros da
cobrana. O PagSeguro, aps validar e armazenar os dados da assinatura devolver um cdigo identificador
para que o seu site redirecione o cliente para a tela de autorizao de assinatura.
Ateno: O cdigo identificador retornado na chamada acima no o cdigo da
assinatura e sim apenas um token para redirecionar o cliente para o checkout. O cdigo
da assinatura retornado no final do processo de assinatura pelo cliente que ser visto
mais frente.
Entre os parmetros enviados constam informaes como a descrio da assinatura, valor a ser cobrado, a
periodicidade da cobrana e etc. Tambm possvel definir de que forma as cobranas sero realizadas, ou
seja, definir se a assinatura ser cobrada automaticamente pelo PagSeguro ou manualmente pelo seu
sistema. Temos assim dois formatos de integrao: Automtica ou Manual.
Este documento trata do formato Automtico. Veja abaixo as suas caractersticas:
VERSO 1.0.0
MODELO AUTOMTICO
MODELO MANUAL
Cobrana
Retentativa de cobrana em
caso de cobrana sem sucesso
por falta de saldo ou carto
fora da validade.
O modelo automtico no
contempla retentativas. Uma
vez perdida a cobrana, no
prximo ser cobrado somente
o valor do ms corrente. O
valor que ficou em aberto deve
ser cobrado atravs de um
envio de cobrana ou de outra
forma escolhida.
Tipo de cobrana
Permite os modelos pr e ps
pago onde voc efetua a
cobrana no final do perodo,
como em uma conta de
telefone.
A seleo do formato da assinatura feita atravs chamada ao servio de Requisies do PagSeguro pelo
parmetro charge (charge para XML e preApprovalCharge para HTTP) que pode ser definido como auto para
o formato Automtico ou manual para o formato Manual.
Nesta documentao, todas as chamadas sero efetuadas utilizando o parmetro com o valor auto. Vejamos
abaixo como funciona o servio de Requisio de Assinatura.
VERSO 1.0.0
Observao: caso sua aplicao ou loja no utilize o conjunto de caracteres ISO-8859-1, p.e.(UTF-8),
necessrio substituir o parmetro charset do exemplo acima.
Veja abaixo um exemplo completo de uma requisio para o servio de Assinatura do PagSeguro informando
os dados do pagamento em parmetros HTTP (as linhas foram quebradas para facilitar a leitura).
curl -k https://ws.pagseguro.uol.com.br/v2/pre-approvals/request -d\
"email={mail}\
&token={token}\
&senderName=Nome do Cliente\
&senderAreaCode=11\
&senderPhone=56273440\
&senderEmail=cliente@uol.com.br\
&senderAddressStreet=Avenida Brigadeiro Faria Lima\
&senderAddressNumber=1384\
&senderAddressComplement=1 Andar\
&senderAddressDistrict=Jardim Paulistano\
&senderAddressPostalCode=01452002\
&senderAddressCity=So Paulo\
&senderAddressState=SP\
&senderAddressCountry=BRA\
&preApprovalCharge=auto\
&preApprovalName=Seguro contra roubo de Notebook\
&preApprovalDetails=Todo dia 28 ser cobrado o valor de R100,00 referente ao seguro contra roubo
de Notebook.\
&preApprovalAmountPerPayment=100.00\
&preApprovalPeriod=Monthly\
&preApprovalFinalDate=2014-01-21T00:00:000-03:00\
&preApprovalMaxTotalAmount=2400.00
&reference=REF1234\
&redirectURL=http://www.seusite.com.br/retorno.php\
&reviewURL=http://www.seusite.com.br/revisao.php\
VERSO 1.0.0
10
<code>DC2DAC98FBFBDD1554493F94E85FAE05</code>
3.
<date>2014-01-21T00:00:00.000-03:00</date>
4. </preApprovalRequest>
VERSO 1.0.0
11
Caso ocorra algum erro na chamada ao servio de Assinatura 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>11072</code>
4.
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.
Aps encaminhar o cliente para a URL acima, ele efetuar a autorizao com o carto de crdito, o cliente
ser encaminhado
Notificao
O PagSeguro encaminha notificaes ao seu sistema para que voc possa obter informaes das transaes
e assinaturas geradas e suas mudanas de status.
A Imagem 3 ilustra o funcionamento do servio de Notificaes. Note que o PagSeguro que inicia o
processo de notificao ao enviar um cdigo para seu sistema.
Imagem 3
VERSO 1.0.0
12
Voc pode definir a URL de notificao atravs da pgina de configuraes do PagSeguro atravs do
endereo:
https://pagseguro.uol.com.br/integracao/notificacao-de-transacoes.jhtml
Uma vez configurado o endereo para onde o PagSeguro ir enviar notificaes, o prximo passo preparar
seu sistema para receber, nesse endereo, um cdigo de notificao.
Quando uma assinatura for criada, voc receber dois tipos de se notificao: notificaes de assinatura e
notificaes de transao.
Notificao de assinatura
As notificaes de assinatura possuem os dados da assinatura como tambm o seu status e as permisses
concedidas. O PagSeguro envia as notificaes de assinatura para a URL que voc configurou usando o
protocolo HTTP, pelo mtodo POST.
Veja abaixo um exemplo de notificao de assinatura enviada pelo PagSeguro (as linhas foram quebradas
para facilitar a leitura):
POST http://lojamodelo.com.br/notificacao HTTP/1.1
Host:pagseguro.uol.com.br
Content-Length:85
Content-Type:application/x-www-form-urlencoded
notificationCode=766B9C-AD4B044B04DA-77742F5FA653-E1AB24
¬ificationType=preApproval
Notificao de transao
As notificaes de transao possuem os dados da transao como por exemplo os valores cobrados, cdigo
da transao, itens e o status da transao. O PagSeguro envia as notificaes de assinatura para a URL que
voc configurou usando o protocolo HTTP, pelo mtodo POST.
Veja abaixo um exemplo de notificao de assinatura enviada pelo PagSeguro (as linhas foram quebradas
para facilitar a leitura):
POST http://lojamodelo.com.br/notificacao HTTP/1.1
Host:pagseguro.uol.com.br
Content-Length:85
Content-Type:application/x-www-form-urlencoded
notificationCode=566B9C-AD4B044B04DA-77742F5FA653-E1AB24
¬ificationType=transaction
VERSO 1.0.0
13
Consulta de assinaturas
Para consultar dados de uma assinatura a loja deve fazer uma requisio informando, alm das credenciais,
os dados necessrios para a consulta usando o mtodo HTTP GET.
VERSO 1.0.0
14
Para ambas as consultas acima, a resposta dada em formato XML, como no exemplo abaixo.
1. <preApproval>
2.
3.
<code>C08984179E9EDF3DD4023F87B71DE349</code>
4.
<date>2011-11-23T13:40:23.000-02:00</date>
5.
<tracker>538C53</tracker>
6.
<status>CANCELLED</status>
7.
<reference>REF1234</reference>
8.
<lastEventDate>2011-11-25T20:04:23.000-02:00</lastEventDate>
9.
<charge>auto</charge>
10.
<sender>
11.
<name>Nome Comprador</name>
12.
<email>comprador@uol.com</email>
13.
<phone>
14.
<areaCode>11</areaCode>
15.
<number>30389678</number>
16.
</phone>
17.
<address>
18.
<street>ALAMEDA ITU</street>
19.
<number>78</number>
20.
<complement>ap. 2601</complement>
21.
<district>Jardim Paulista</district>
22.
<city>SAO PAULO</city>
23.
<state>SP</state>
24.
<country>BRASIL</country>
25.
<postalCode>01421000</postalCode>
26.
27.
</address>
</sender>
28. </preApproval>
VERSO 1.0.0
15
Para as consultas por intervalo de dias e de data, o resultado apresentado em XML conforme o exemplo
abaixo:
1. <preApprovalSearchResult>
2.
<resultsInThisPage>1</resultsInThisPage>
3.
<currentPage>1</currentPage>
4.
<totalPages>1</totalPages>
5.
<date>2011-08-08T16:16:23.000-03:00</date>
6.
<preApprovals>
7.
<preApproval>
8.
9.
<code>12E10BEF5E5EF94004313FB891C8E4CF</code>
10.
<date>2011-08-15T11:06:44.000-03:00</date>
11.
<tracker>624C17</tracker>
12.
<status>INITIATED</status>
13.
<reference>R123456</reference>
14.
<lastEventDate>2011-08-08T15:37:30.000-03:00</lastEventDate>
15.
<charge>auto</charge>
16.
17.
</preApproval>
</preApprovals>
18. </preApprovalSearchResult>
<error>
3.
<code>13014</code>
4.
5.
</error>
6. </errors>
Consulta de transaes
A consulta de transaes est explicada de forma completa atravs do link abaixo:
https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-notificacoes.html
VERSO 1.0.0
16
<date>2011-08-31T13:43:23.000-03:00</date>
3.
<status>OK</status>
4. </result>
<error>
3.
<code>17022</code>
4.
<message>invalid pre-approval status to execute the requested operation. Preapproval status is CANCELLED_BY_RECEIVER.</message>
5.
</error>
6. </errors>
Listagem de Parmetros
Veja abaixo a listagem completa de todos os parmetros. Todos os parmetros so Case sensitive:
Autenticao
PARMETRO
VERSO 1.0.0
DESCRIO
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.
17
PARMETRO
DESCRIO
Especifica o token correspondente conta PagSeguro que est realizando a
requisio.
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
token
Requisio
PARMETRO
HTML
senderName
XML
<preApprovalRequest>
<sender>
<name>
HTML
senderAreaCode
XML
<preApprovalRequest>
<sender>
<phone>
<areaCode>
HTML
senderPhone
XML
<preApprovalRequest>
<sender>
<phone>
<number>
HTML
senderEmail
XML
<preApprovalRequest>
<sender>
<email>
VERSO 1.0.0
DESCRIO
Nome completo do comprador.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com no mnimo duas sequncias de strings e limite
total de 50 caracteres.
E-mail do comprador.
Presena: Opcional.
Tipo: Texto.
Formato: Um e-mail vlido, com limite de 60 caracteres.
18
PARMETRO
HTML
senderAddressStreet
XML
<preApprovalRequest>
<sender>
<address>
<street>
HTML
senderAddressNumber
XML
<preApprovalRequest>
<sender>
<address>
<number>
HTML
senderAddressComplement
XML
preApprovalRequest>
<sender>
<address>
<complement>
HTML
senderAddressDistrict
XML
<preApprovalRequest>
<sender>
<address>
<district>
HTML
senderAddressPostalCode
XML
<preApprovalRequest>
<sender>
<address>
<postalCode>
VERSO 1.0.0
DESCRIO
Endereo do comprador.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com limite de 80 caracteres.
19
PARMETRO
HTML
senderAddressCity
XML
<preApprovalRequest>
<sender>
<address>
<city>
HTML
senderAddressState
XML
<preApprovalRequest>
<sender>
<address>
<state>
HTML
senderAddressCountry
XML
<preApprovalRequest>
<sender>
<address>
<country>
HTML
preApprovalCharge
XML
<preApprovalRequest>
<preApproval>
<charge>
HTML
preApprovalName
XML
<preApprovalRequest>
<preApproval>
<name>
HTML
preApprovalDetails
XML
<preApprovalRequest>
<preApproval>
<details>
VERSO 1.0.0
DESCRIO
Cidade do endereo do comprador.
Presena: Opcional.
Tipo: Texto.
Formato: Deve ser um nome vlido de cidade do Brasil, com no
mnimo 2 e no mximo 60 caracteres.
Detalhes/Descrio da assinatura.
Presena: Opcional.
Tipo: Texto.
Formato: Livre, com limite de 255 caracteres.
20
PARMETRO
HTML
preApprovalAmountPerPayment
XML
<preApprovalRequest>
<preApproval>
<amountPerPayment>
HTML
preApprovalMaxAmountPerPayment
XML
<preApprovalRequest>
<preApproval>
<maxAmountPerPayment>
HTML
preApprovalPeriod
XML
<preApprovalRequest>
<preApproval>
<period>
HTML
preApprovalFinalDate
XML
<preApprovalRequest>
<preApproval>
<finalDate>
HTML
preApprovalMaxTotalAmount
XML
<preApprovalRequest>
<preApproval>
<maxTotalAmount>
HTML
receiverEmail
XML
<preApprovalRequest>
<receiver>
<email>
VERSO 1.0.0
DESCRIO
Valor exato de cada cobrana.
Presena: Obrigatrio para o modelo automtico.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto (p.e,
1234.56). Deve ser um valor maior ou igual a 1.00 e menor ou igual a
2000.00
Obs.: No pode ser utilizado em conjunto com
preApprovalMaxAmountPerPayment.
Valor mximo de cada cobrana.
Presena: Opcional.
Tipo: Nmero.
Formato: Decimal, com duas casas decimais separadas por ponto (p.e,
1234.56). Deve ser um valor maior ou igual a 1.00 e menor ou igual a
2000.00
Obs.: No pode ser utilizado em conjunto com
preApprovalAmountPerPayment.
Periodicidade da cobrana.
Presena: Obrigatria.
Tipo: Texto.
Formato: Case insensitive. Reconhece os valores WEEKLY, MONTHLY,
BIMONTHLY, TRIMONTHLY, SEMIANNUALLY, YEARLY.
21
PARMETRO
HTML
redirectURL
XML
<preApprovalRequest>
<redirectURL>
HTML
reference
XML
<preApprovalRequest>
<reference>
HTML
reviewURL
XML
<preApprovalRequest>
<reviewURL>
DESCRIO
URL para onde o comprador ser redirecionado aps a finalizao do
fluxo de assinatura.
Presena: Opcional.
Tipo: Texto.
Formato: Uma URL vlida, com limite de 255 caracteres.
Resposta da assinatura
PARMETRO
DESCRIO
<preApprovalRequest>
<preApprovalRequest>
<code>
Cdigo de requisio criado. Este cdigo deve ser usado para direcionar
o comprador para o fluxo de aprovao.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
<preApprovalRequest>
<date>
Data da requisio.
Tipo: Data/Hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD.
VERSO 1.0.0
22
Notificao
PARMETRO
DESCRIO
notificationCode
O cdigo que identifica a notificao. Este cdigo deve ser usado para
consultar a notificao e obter os dados da transao/assinatura
associada. Note que o cdigo que identifica a notificao no o
mesmo que o cdigo que identifica a transao.
Tipo: Texto.
Formato: Uma sequncia de 39 caracteres.
notificationType
DESCRIO
approvals/)
DESCRIO
<preApproval>
<preApproval>
<name>
Nome/Descrio da assinatura.
Tipo: Texto.
<preApproval>
<code>
<preApproval>
<date>
<preApproval>
<tracker>
<preApproval>
VERSO 1.0.0
23
PARMETRO
<status>
DESCRIO
Tipo: Texto.
VALOR
DESCRIO
PENDING
Identificador que foi usado para fazer referncia a assinatura no momento de sua
requisio/cobrana.
Tipo: Texto.
<preApproval>
<lastEventDate>
<preApproval>
<charge>
VERSO 1.0.0
24
PARMETRO
DESCRIO
Tipo: Texto.
Formato: Retorna apenas os valores manual ou auto.
<preApproval>
<sender>
<name>
<preApproval>
<sender>
<phone>
<areaCode>
<preApproval>
<sender>
<phone>
<number>
<preApproval>
<sender>
<email>
E-mail do comprador.
Tipo: Texto.
Formato: Um e-mail vlido, com limite de 60 caracteres.
<preApproval>
<sender>
<address>
<street>
Endereo do comprador.
Tipo: Texto.
Formato: Livre, com limite de 80 caracteres.
<preApproval>
<sender>
<address>
<number>
<preApproval>
<sender>
<address>
<complement>
<preApproval>
<sender>
<address>
<district>
<preApproval>
<sender>
<address>
<postalCode>
<preApproval>
VERSO 1.0.0
25
PARMETRO
DESCRIO
<sender>
<address>
<city>
Tipo: Texto.
Formato: Deve ser um nome vlido de cidade do Brasil, com no mnimo 2 e no
mximo 60 caracteres.
<preApproval>
<sender>
<address>
<state>
<preApproval>
<sender>
<address>
<country>
DESCRIO
<preApprovalSearchResult>
<preApprovalSearchResult>
<resultsInThisPage>
<preApprovalSearchResult>
<currentPage>
<preApprovalSearchResult>
<totalPages>
<preApprovalSearchResult>
<date>
<preApprovalSearchResult>
<preApprovals>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<preApprovalSearchResult>
<preApprovals>
<preApproval><name>
Nome/Descrio da assinatura.
Tipo: Texto.
VERSO 1.0.0
26
PARMETRO
DESCRIO
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<code>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<date>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<tracker>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<status>
VERSO 1.0.0
DESCRIO
27
PARMETRO
DESCRIO
EXPIRED
Tipo: Texto.
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<reference>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<lastEventDate>
<preApprovalSearchResult>
<preApprovals>
<preApproval>
<charge>
Cancelamento de assinatura
PARMETRO
preApprovalCode
DESCRIO
Cdigo da assinatura a ser cancelada.
Presena: Obrigatria.
Tipo: Texto.
Formato: Uma sequncia de 32 caracteres.
DESCRIO
<result>
Dados do Cancelamento
<result>
<date>
<result>
<status>
VERSO 1.0.0
28
Parmetros de erro
PARMETRO
DESCRIO
<errors>
Lista de erros.
<errors>
<error>
<errors>
<error>
<code>
Cdigo do erro.
Tipo: Texto.
Formato: Ver Tabela de Erros.
<errors>
<error>
<message>
Mensagem descritiva.
Tipo: Texto.
Formato: Ver Tabela de Erros.
Tabela de Erros
Caso sua aplicao informe algum dado incorreto ou fora do padro esperado pela aplicao, ser retornado
uma mensagem informando o problema. Confira abaixo os erros que podem ser retornados:
HTTP 401 - Unauthorized
Ocorre quando sua aplicao encaminhou uma credencial (e-mail ou token) invalida ou inexistente.
HTTP 405 Method Not Allowed
Ocorre quando sua aplicao efetuou a chamada utilizando um mtodo no esperado. Neste caso verifique
se o mtodo da chamada GET ou POST.
HTTP 415 Cannot consume content type
Ocorre quando no encaminhado o Content-Type na chamada.
HTTP 400 Bad Request
Ocorre quando um ou mais dados foram encaminhados de forma incorreta ou fora do padro. Este retorno
possui um XML no corpo na mensagem que identifica quais os erros presentes na chamada. O XML possui o
seguinte formato:
PARMETRO
DESCRIO
10003
11001
receiverEmail is required.
11002
11003
11004
Currency is required.
VERSO 1.0.0
29
PARMETRO
DESCRIO
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
ShippingType is required.
11016
11017
11018
11019
11020
11021
11022
11023
shippingAddressState invalid value: , must fit the pattern: \w{2} (e. g. "SP")
11024
11025
Item Id is required.
11026
11027
11028
11029
VERSO 1.0.0
30
PARMETRO
DESCRIO
11030
11031
11032
11033
11034
11035
11036
11037
11038
Invalid receiver for checkout: , verify receiver's account status and if it is a seller's account.
11039
11040
11041
11042
11043
11054
11055
11056
11057
11058
11059
preApprovalDetails invalid value: . Must be a text with any letters, numbers, spaces and the
following symbols -+.@,;:/|*?!=$#()
11060
11061
11062
11063
11064
VERSO 1.0.0
31
PARMETRO
DESCRIO
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
preApprovalInitialDate invalid date. It must be between current date and current date plus
2 years.
11079
11080
11081
11082
11083
11084
11085
11088
preApprovalName is required
VERSO 1.0.0
32
PARMETRO
DESCRIO
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
preApprovalDetails is required.
11101
11102
11103
11104
11105
11106
11107
11108
11109
VERSO 1.0.0
33
PARMETRO
DESCRIO
11110
11111
11112
11113
11114
13001
13002
13003
13004
initialDate is required.
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
VERSO 1.0.0
34
PARMETRO
DESCRIO
13021
the requested operation does not support the requested transaction because it's status is:
17001
17002
17003
17004
item id is required.
17005
17006
17007
17008
17009
17010
17011
pre-approval exceeded the maximum amount in the period. Limit is: {1}
17012
17013
17014
17015
17016
17017
17018
this pre-approval exceeded total payments per period. Limit is: {1}
17019
17020
17021
17022
17023
17024
VERSO 1.0.0
35
PARMETRO
DESCRIO
17025
17026
17027
17028
17029
preApprovalMaxTotalAmount is required.
17030
17031
preApprovalFinalDate is required.
VERSO 1.0.0