API Consulta

Com esta API você pode consultar transações através do código de referência ou informando um intervalo de datas com o intuito de atualizar os dados dos pedidos em sua aplicação. Você também pode consultar detalhes das transações para mais informações. Conheça cada uma delas a seguir.

Busca de Transações pelo Código de Referência ou Intervalo de Datas
Consulta dos Detalhes da Transação
Parâmetros da API
Resposta da API
Tabela de Erros

Busca de Transações pelo Código de Referência ou Intervalo de Datas

Com esta API você pode consultar transações através do código de referência atrelado a ela, ou seja, o código passado no campo reference. Há também a opção de consultar as transações recebidas por você em um intervalo de datas para verificar se o seu sistema recebeu todas as notificações de transações enviadas pelo PagSeguro, de forma a conciliar as transações armazenadas em seu sistema com o PagSeguro.

Para consultar a lista de transações, você deve fazer uma requisição à API de Consulta de Transações informando o código de referência ou o intervalo de datas desejado. O PagSeguro irá retornar todas as transações que foram criadas com esse código ou que foram criadas entre as datas solicitadas. A chamada a esse serviço requer a utilização do protocolo HTTP para a URL abaixo.

GET https://ws.pagseguro.uol.com.br/v2/transactions?{{credenciais}}

Veja abaixo o exemplo de requisição ao PagSeguro informando o código de referência (as linhas foram quebradas para facilitar a leitura).

https://ws.pagseguro.uol.com.br/v2/transactions?{{credenciais}}
&reference=REF123456

Também é possível definir uma data limite para a pesquisa, conforme exemplo abaixo.

📘

Lembrando que o limite para busca através da API é de 120 dias, para obter a lista de transações com uma data anterior a essa será necessário verificar no extrato de transações de sua conta PagSeguro.

https://ws.pagseguro.uol.com.br/v2/transactions?{{credenciais}}
&initialDate=2011-01-01T00:00
&finalDate=2011-01-28T00:00
&page=1
&maxPageResults=100

Para mais informações sobre os parâmetros a serem enviados, consulte a seção Parâmetros da API. Os detalhes sobre o retorno estão na Resposta da API .

Consulta dos Detalhes da Transação

Esta consulta possibilita o acesso a todos os dados de uma transação a partir do código identificador. Ela é bastante útil quando você habilita o recebimento do código da transação no redirecionamento. Você também pode usá-la para consultar mais detalhes de transações obtidas com a consulta de transações por código de referência ou intervalo de datas.

Para consultar os detalhes de uma transação por código identificador, você deve fazer uma requisição à API de Consulta de Transações informando o código da transação. A chamada a esse serviço requer a utilização do protocolo HTTP para a URL abaixo.

GET https://ws.pagseguro.uol.com.br/v3/transactions/{{codigo-transacao}}?{{credenciais}}

Veja abaixo um exemplo para consultar uma transação (as linhas foram quebradas para facilitar a leitura).

https://ws.pagseguro.uol.com.br/v3/transactions/9E884542-81B3-4419-9A75-BCC6FB495EF1
?{{credenciais}}

Para mais informações sobre os parâmetros a serem enviados, consulte a seção Parâmetros da API. Os detalhes sobre o retorno estão na Resposta da API .

Parâmetros da API

Abaixo são descritos os parâmetros usados na consulta de transações.

Resposta da API

A resposta da consulta é dada em formato XML. Repare que nem todos os detalhes das transações são retornados na busca de transações por código de referência ou intervalo de datas. Você pode utilizar a consulta por código de transação para obter mais detalhes, caso necessário. Veja um exemplo de resposta da busca de transações por código de referência ou intervalo de datas.

<transactionSearchResult>
    <date>2011-02-16T20:14:35.000-02:00</date>
    <currentPage>1</currentPage>
    <resultsInThisPage>10</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>9E884542-81B3-4419-9A75-BCC6FB495EF1</code>
            <reference>REF123456</reference>
            <type>1</type>
            <status>3</status>
            <paymentMethod>
                <type>1</type>
            </paymentMethod>
            <grossAmount>49900.00</grossAmount>
            <discountAmount>0.00</discountAmount>
            <feeAmount>0.00</feeAmount>
            <netAmount>49900.00</netAmount>
            <extraAmount>0.00</extraAmount>
        </transaction>
        <transaction>
            <date>2011-02-07T18:57:52.000-02:00</date>
            <lastEventDate>2011-02-14T21:37:24.000-03:00</lastEventDate>
            <code>2FB07A22-68FF-4F83-A356-24153A0C05E1</code>
            <reference>REF123456</reference>
            <type>3</type>
            <status>4</status>
            <paymentMethod>
                <type>3</type>
            </paymentMethod>
            <grossAmount>26900.00</grossAmount>
            <discountAmount>0.00</discountAmount>
            <feeAmount>0.00</feeAmount>
            <netAmount>26900.00</netAmount>
            <extraAmount>0.00</extraAmount>
        </transaction>
    </transactions>
</transactionSearchResult>

Veja abaixo um exemplo de consulta por código de transação.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<transaction>
    <date>2017-12-04T17:19:31.000-02:00</date>
    <code>79E53362-F6B2-4DFF-B3FD-23B4E0C19B35</code>
    <reference>REF1234</reference>
    <type>1</type>
    <status>1</status>
    <lastEventDate>2017-12-04T17:19:32.000-02:00</lastEventDate>
    <paymentMethod>
        <type>2</type>
        <code>202</code>
    </paymentMethod>
    <paymentLink>https://pagseguro.uol.com.br/checkout/payment/booklet/print.jhtml?c=62238ca9db0aa8913528210ce3d7c7d4e72d138f985eb97976d39013d22fed1283fc0072edc1a23c</paymentLink>
    <grossAmount>998.98</grossAmount>
    <discountAmount>0.00</discountAmount>
    <creditorFees>
        <operationalFeeAmount>1.00</operationalFeeAmount>
        <intermediationRateAmount>0.40</intermediationRateAmount>
        <intermediationFeeAmount>39.82</intermediationFeeAmount>
    </creditorFees>
    <netAmount>957.76</netAmount>
    <extraAmount>-0.01</extraAmount>
    <installmentCount>1</installmentCount>
    <itemCount>2</itemCount>
    <items>
        <item>
            <id>0001</id>
            <description>Notebook Prata</description>
            <quantity>1</quantity>
            <amount>998.98</amount>
        </item>
        <item>
            <id>0002</id>
            <description>Notebook Rosa</description>
            <quantity>1</quantity>
            <amount>0.01</amount>
        </item>
    </items>
    <sender>
        <name>Jose Comprador</name>
        <email>[email protected]</email>
        <phone>
            <areaCode>11</areaCode>
            <number>56713293</number>
        </phone>
    </sender>
    <primaryReceiver>
        <publicKey>PUB175E07D7FB62462BAE3C9A60EA1B32AE</publicKey>
    </primaryReceiver>
</transaction>

Abaixo são descritos os parâmetros usados na consulta de transações. Os parâmetros dentro da estrutura indicam campos retornados na busca pelo código de referência ou intervalo de datas. Os parâmetros dentro de são retornados tanto pela API de busca pelo código de referência e intervalo de datas como pela consulta dos detalhes da transação, porém os campos marcados com * (asterisco) pertencem somente a API de consulta pelo código de transação.

Parâmetros retornados na API de busca pelo código de referência e intervalo de datas

Parâmetros retornados na API de consulta por código de transação