Consulta de Transações Abandonadas

Visão Geral

Transações abandonadas são aquelas nas quais o comprador iniciou o fluxo de pagamento, mas abandonou o processo sem concluí-lo. A consulta destas transações é útil para que você identifique quais transações não foram concluídas devido ao abandono do fluxo de pagamento e tente fazer algum processo de recuperação junto ao comprador.

Consultas por Data

Legendas

Transações apenas são consideradas abandonadas ao ultrapassar 15 minutos da data de criação da mesma.

Integração

Para consultar transações abandonadas, você deve fazer uma requisição à API de Consulta de transações, filtrando por transações abandonadas e informando o intervalo de datas desejado. O PagSeguro irá retornar todas as transações direcionadas para sua conta que foram criadas e abandonadas nesse intervalo. Veja abaixo um exemplo de chamada a essa API, que requer a utilização do protocolo HTTP e o método GET (as linhas foram quebradas para facilitar a leitura).

Observação Para utilizar a Sandbox PagSeguro para realizar a homologação da sua requisição, utilize o endpoint: https://ws.sandbox.pagseguro.uol.com.br/v2/transactions/abandoned ao invés de https://ws.pagseguro.uol.com.br/v2/transactions/abandoned

https://ws.pagseguro.uol.com.br/v2/transactions/abandoned
?initialDate=2011-01-01T00:00
&finalDate=2011-01-28T00:00
&page=1
&maxPageResults=100
&email=suporte@lojamodelo.com.br
&token=95112EE828D94278BD394E91C4388F20

Parâmetros de Consulta

PARÂMETRO DESCRIÇÃO
initialDate Data inicial do intervalo.

Especifica a data inicial do intervalo de pesquisa. Somente transações criadas a partir desta data serão retornadas. Esta data não pode ser anterior a 6 meses da data corrente.

Presença: Obrigatória.
Tipo: Data/hora, com precisão de minutos.
Formato: YYYY-MM-DDThh:mm, o formato oficial do W3C para datas. Veja mais sobre formatação de datas.
finalDate Data final do intervalo.

Especifica a data final do intervalo de pesquisa.
A diferença entre initialDate e finalDate não pode ser superior a 30 dias. finalDate deve ser no máximo a hora atual menos 15 minutos

Presença: Obrigatória.
Tipo: Data/hora, com precisão de minutos.
Formato: YYYY-MM-DDThh:mm, o formato oficial do W3C para datas. Veja mais sobre formatação de datas.
page página de resultados a ser retornada.

O Número de resultados retornado pela consulta por intervalo de datas pode ser grande, portanto é possível fazer a paginação dos resultados. A primeira página retornada é 1 e assim por diante. Este parâmetro especifica qual é a página de resultados a ser retornada.

Presença: Opcional. Se não especificada, a página 1 é retornada.
Tipo: Número.
Formato: Inteiro.
maxPageResults Número máximo de resultados por página.

Para limitar o tamanho da resposta de cada chamada à consulta, é possível especificar um número máximo de resultados por página. Este parâmetro permite especificar este limite.

Presença: Opcional. Se não especificada, serão retornados 50 resultados por página.
Tipo: Número.
Formato: Inteiro entre 1 e 1000.
email E-mail da conta que chama a API.

E-mail associado à conta PagSeguro que está realizando a chamada à API.

Presença: Obrigatória.
Tipo: Texto.
Formato: um e-mail válido (p.e., usuario@site.com.br), com no máximo 60 caracteres.
token Token da conta que chama a API.

Token correspondente á conta PagSeguro que está realizando a chamada à API. Para criar um token para sua conta PagSeguro, acesse a página de configurações de pagamentos.

Presença: Obrigatória.
Tipo: Texto.
Formato: uma sequência de 32 caracteres.

Exemplo de resposta

A resposta da consulta de transações abandonadas é dada em formato XML. Note que transações abandonadas não têm várias informações presentes em transações finalizadas, portanto há um Número menor de campos no XML de resposta a esta consulta. Veja uma resposta no exemplo abaixo.

<transactionSearchResult>  
    <date>2011-02-16T20:14:35.000-02:00</date>  
    <currentPage>1</currentPage>  
    <resultsInThisPage>2</resultsInThisPage>  
    <totalPages>1</totalPages>  
    <transactions>  
        <transaction>  
            <date>2011-02-05T15:46:12.000-02:00</date>  
            <lastEventDate>2011-02-15T17:39:14.000-03:00</lastEventDate>  
            <code>EDDDC505-8A26-494E-96C2-53D285A470C2</code>  
            <type>1</type>  
            <grossAmount>6.00</grossAmount>  
        </transaction>  
        <transaction>  
            <date>2011-02-07T18:57:52.000-02:00</date>  
            <lastEventDate>2011-02-14T21:37:24.000-03:00</lastEventDate>  
            <reference>REFCODE2</reference>  
            <code>97B1F57E-0EC0-4D03-BF7E-C4694CF6062E</code>  
            <type>1</type>  
            <grossAmount>6.00</grossAmount>  
        </transaction>  
    </transactions>  
</transactionSearchResult>   

Parâmetros de resposta

PARÂMETRO DESCRIÇÃO
<transactionSearchResult>
<date>
Data da consulta.

Informa o momento em que a consulta foi realizada.

Presença: Obrigatória.
Tipo: Data/hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C para datas. Veja mais sobre formatação de datas.
<transactionSearchResult>
<currentPage>
Índice da página atual.

Informa o índice da página de resultados sendo consultada. A primeira página de resultados é a de Número 1 e assim por diante.

Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.
<transactionSearchResult>
<resultsInThisPage>
Número de resultados na página atual.

Indica o Número de resultados presentes na página atual.

Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.
<transactionSearchResult>
<totalPages>
Número total de páginas.

Informa o Número total de páginas no resultado da busca.

Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.
<transactionSearchResult>
<transactions>
Representa as transações retornadas pela consulta.
<transactionSearchResult>
<transactions>
<transaction>
Dados de uma transação retornada pela consulta.
<transactionSearchResult>
<transactions>
<transaction>
<date>
Data da criação da transação.

Informa o momento em que a transação foi criada.

Presença: Obrigatória.
Tipo: Data/hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C para datas. Veja mais sobre formatação de datas.
<transactionSearchResult>
<transactions>
<transaction>
<lastEventDate>
Data do último evento.

Informa o momento em que ocorreu a última alteração no status da transação.

Presença: Obrigatória.
Tipo: Data/hora.
Formato: YYYY-MM-DDThh:mm:ss.sTZD, o formato oficial do W3C para datas. Veja mais sobre formatação de datas.
<transactionSearchResult>
<transactions>
<transaction>
<code>
Código identificador da transação

Retorna o código que identifica a transação de forma única.

Presença: Obrigatória.
Tipo: Texto.
Formato: Uma sequência de 36 caracteres.
<transactionSearchResult>
<transactions>
<transaction>
<reference>
Código de referência da transação.

Informa o código que foi usado para fazer referência ao pagamento. Este código foi fornecido no momento do pagamento e é útil para vincular as transações do PagSeguro com as vendas registradas no seu sistema.

Presença: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 200 caracteres.
<transactionSearchResult>
<transactions>
<transaction>
<type>
Tipo da transação.

Representa o tipo da transação recebida. Os valores mais comuns para este campo e seus respectivos resultados são descritos abaixo.

CodigoSignificado
1Pagamento: a transação foi criada por um comprador fazendo um pagamento. Este é o tipo mais comum de transação que você irá receber.

Outros tipos menos comuns de transações foram omitidos. Note que novos tipos podem ser adicionados em versões futuras da API.

Presença:\ Obrigatória.
Tipo: Número.
Formato:** Inteiro.
<transactionSearchResult>
<transactions>
<transaction>
<grossAmount>
Valor bruto da transação.

Informa o valor bruto da transação, calculado pela soma dos preços de todos os itens presentes no pagamento.

Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.