PagSeguro Developers_

Tudo o que você precisa em serviços de pagamentos.

Aqui você encontra as documentações necessárias para integrar com as APIs, Bibliotecas e Módulos do PagSeguro.

Descubra tudo que a nossa plataforma pode te proporcionar!

Get Started    Referência da API

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.

PARÂMETRO
DESCRIÇÃO

reference

Código de referência da transação. Código informado na criação da transação para fazer referência ao pagamento.
Presença: Obrigatória.
Tipo: Texto.
Formato: Livre, com no máximo 200 caracteres.

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: Opcional, exceto pesquisa relacionada a data.
Tipo: Data/hora, com precisão de minutos.
Formato:YYYY-MM-DDThh:mm:ss.sTZD**, 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.
Presença: Opcional.
Tipo: Data/hora, com precisão de minutos.
Formato: YYYY-MM-DDThh:mm:ss.sTZD**, 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 código de referência 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.

*transactionCode

Código que identifica a transação. Código da transação que será consultada.
Presença: Obrigatória.
Tipo: Texto.
Formato: Uma sequência de 36 caracteres, com os hífens, ou 32 caracteres, sem os hífens.

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>jose@dominio.com.br</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 <transactionSearchResult> indicam campos retornados na busca pelo código de referência ou intervalo de datas. Os parâmetros dentro de <transaction> 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Â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>
<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 às 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.

1- Pagamento: 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>
<status>

Status da transação. Informa o código representando o status da transação, permitindo que você decida se deve liberar ou não os produtos ou serviços adquiridos. Os valores possíveis estão descritos no diagrama de status de transações e são apresentados juntamente com seus respectivos códigos na tabela abaixo.

CodigoSignificado
1Aguardando pagamento: o comprador iniciou a transação, mas até o momento o PagSeguro não recebeu nenhuma informação sobre o pagamento.
2Em análise: o comprador optou por pagar com um cartão de crédito e o PagSeguro está analisando o risco da transação.
3Paga: a transação foi paga pelo comprador e o PagSeguro já recebeu uma confirmação da instituição financeira responsável pelo processamento.
4Disponível: a transação foi paga e chegou ao final de seu prazo de liberação sem ter sido retornada e sem que haja nenhuma disputa aberta.
5Em disputa: o comprador, dentro do prazo de liberação da transação, abriu uma disputa.
6Devolvida: o valor da transação foi devolvido para o comprador.
7Cancelada: a transação foi cancelada sem ter sido finalizada.
8Debitado: o valor da transação foi devolvido para o comprador.
9Retenção temporária: o comprador abriu uma solicitação de chargeback junto à operadora do cartão de crédito.

Outros status menos relevantes foram omitidos. Em resumo, você deve considerar transações nos status de Paga para liberação de produtos ou serviços.
Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.

<transactionSearchResult>
<transactions>
<transaction>
<cancellationSource>

Origem do cancelamento. Informa a origem do cancelamento da transação: pelas instituições financeiras (Banco Emissor ou Operadora do Cartão) ou pelo PagSeguro.

ValorSignificado
INTERNALPagSeguro
EXTERNALInstituições Financeiras

Presença: Opcional (somente quando transactionStatus igual a 7).
Tipo: Texto.
Formato: Valores possíveis INTERNAL ou EXTERNAL.

<transactionSearchResult>
<transactions>
<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 transação. A tabela abaixo descreve os valores disponíveis e seus significados.

CodigoSignificado
1Cartão de crédito: o comprador escolheu pagar a transação com cartão de crédito.
2Boleto: o comprador optou por pagar com um boleto bancário.
3Débito online (TEF): o comprador optou por pagar a transação com débito online de algum dos bancos conveniados.
4Saldo PagSeguro: o comprador optou por pagar a transação utilizando o saldo de sua conta PagSeguro.
5Oi Paggo *: o comprador escolheu pagar sua transação através de seu celular Oi.

Os tipos marcados (*) não estão disponíveis para utilização.
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.

<transactionSearchResult>
<transactions>
<transaction>
<discountAmount>

Valor do desconto dado. Informa o valor do desconto dado a compradores que optaram por pagar com débito online ou boleto. Este desconto aplica-se quando você opta por incluir no preço dos produtos o custo do parcelamento de pagamentos com cartão de crédito. O desconto é dado para não onerar os compradores que optaram por meios à vista.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.

<transactionSearchResult>
<transactions>
<transaction>
<feeAmount>

Valor total das taxas cobradas. Informa o valor total das taxas cobradas pelo PagSeguro nesta transação.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.

<transactionSearchResult>
<transactions>
<transaction>
<netAmount>

Valor líquido da transação. Informa o valor líquido da transação, que corresponde ao valor bruto, menos o valor das taxas. Caso presente, o valor de extraAmount (que pode ser positivo ou negativo) também é considerado no cálculo.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.

<transactionSearchResult>
<transactions>
<transaction>
<extraAmount>

Valor extra. Informa um valor extra que foi somado ou subtraído 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.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56 ou -1234.56.

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

PARÂMETRO
DESCRIÇÃO
<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.

<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.

<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.

<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 às vendas registradas no seu sistema.
Presença: Opcional.
Tipo: Texto.
Formato: Livre, com o limite de 200 caracteres.

<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.

  • 1- Pagamento: 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.

<transaction>
<status>

Status da transação. Informa o código representando o status da transação, permitindo que você decida se deve liberar ou não os produtos ou serviços adquiridos. Os valores possíveis estão descritos no diagrama de status de transações e são apresentados juntamente com seus respectivos códigos na tabela de Status da transação

<transaction>
<cancellationSource>

Origem do cancelamento. Informa a origem do cancelamento da transação: pelas instituições financeiras (Banco Emissor ou Operadora do Cartão) ou pelo PagSeguro.
Valor Significado
INTERNAL PagSeguro
EXTERNAL Instituições Financeiras
Presença: Opcional (somente quando transactionStatus igual a 7).
Tipo: Texto.
Formato: Valores possíveis INTERNAL ou EXTERNAL.

<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 transação. A tabela abaixo descreve os valores disponíveis e seus significados.

CodigoSignificado
1Cartão de crédito: o comprador escolheu pagar a transação com cartão de crédito.
2Boleto: o comprador optou por pagar com um boleto bancário.
3Débito online (TEF): o comprador optou por pagar a transação com débito online de algum dos bancos conveniados.
4Saldo PagSeguro: o comprador optou por pagar a transação utilizando o saldo de sua conta PagSeguro.
5 Oi Paggo *: o comprador escolheu pagar sua transação através de seu celular Oi.
7 Depósito em conta: o comprador optou por fazer um depósito na conta corrente do PagSeguro. Ele precisará ir até uma agência bancária, fazer o depósito, guardar o comprovante e retornar ao PagSeguro para informar os dados do pagamento. A transação será confirmada somente após a finalização deste processo, que pode levar de 2 a 13 dias úteis.

  • Os tipos marcados não estão disponíveis para utilização.
    Presença: Obrigatória.
    Tipo: Número.
    Formato: Inteiro.
<transaction>
<paymentLink>

Link para o Pagamento. Informa a URL para a exibição 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 Cartão de crédito este parâmetro será omitido.
Presença: Somente para pagamentos via Boleto e TEF.
Tipo: Texto.
Formato: URL

<transaction>
<paymentMethod>
<code>

Código identificador do meio de pagamento. Informa um código que identifica o meio de pagamento usado pelo comprador. O meio de pagamento descreve a bandeira de cartão de crédito utilizada ou banco escolhido para um débito online. A tabela abaixo descreve os possíveis valores e seus significados.

CodigoSignificado
101Cartão de crédito Visa.
102Cartão de crédito MasterCard.
103Cartão de crédito American Express.
104Cartão de crédito Diners.
105Cartão de crédito Hipercard.
106 Cartão de crédito Aura.
107Cartão de crédito Elo.
108Cartão de crédito PLENOCard.
109Cartão de crédito PersonalCard.
110Cartão de crédito JCB.
111Cartão de crédito Discover.
112Cartão de crédito BrasilCard.
113Cartão de crédito FORTBRASIL.
114Cartão de crédito CARDBAN.
115Cartão de crédito VALECARD.
116Cartão de crédito Cabal.
117Cartão de crédito Mais!.
118Cartão de crédito Avista.
119Cartão de crédito GRANDCARD.
120Cartão de crédito Sorocred.
122Cartão de crédito Up Policard.
123Cartão de crédito Banese Card.
201Boleto Bradesco.
202Boleto Santander.
301Débito online Bradesco.
302Débito online Itaú.
303Débito online Unibanco.
304Débito online Banco do Brasil.
305Débito online Banco Real.
306Débito online Banrisul.
307Débito online HSBC.
401Saldo PagSeguro.
501Oi Paggo. *
701Depósito em conta - Banco do Brasil

  • Os meios de pagamento marcados não estão disponíveis para utilização.
    Presença: Obrigatória.
    Tipo: Número.
    Formato: Inteiro.
<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.

<transaction>
<discountAmount>

Valor do desconto dado. Informa o valor do desconto dado a compradores que optaram por pagar com débito online ou boleto. Este desconto aplica-se quando você opta por incluir no preço dos produtos o custo do parcelamento de pagamentos com cartão de crédito. O desconto é dado para não onerar os compradores que optaram por meios à vista.
Presença: Obrigatória.
Tipo: Número.
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 transação.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.

<transaction>
<netAmount>

Valor líquido da transação. Informa o valor líquido da transação, que corresponde ao valor bruto, menos o valor das taxas. Caso presente, o valor de extraAmount (que pode ser positivo ou negativo) também é considerado no cálculo.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto ("."). Por exemplo, 1234.56.

<transaction>
<escrowEndDate>

Data de crédito. Data em que o valor da transação estará disponível na conta do vendedor.
Presença: Presente apenas quando o status da transação for um dos seguintes valores:
Paga (3), Disponível (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 formatação de datas.

<transaction>
<extraAmount>

Valor extra. Informa um valor extra que foi somado ou subtraído 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.
Presença: Obrigatória.
Tipo: Número.
Formato: Decimal, com duas casas decimais separadas por ponto (“.”). Por exemplo, 1234.56 ou -1234.56.

<transaction>
<installmentCount>

Número de parcelas. Indica o número de parcelas que o comprador escolheu no pagamento com cartão de crédito.
Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.

<transaction>
<itemCount>

Número de itens da transação. Aponta o número de itens contidos nesta transação.
Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.

<transaction>
<items>
<item>
<id>

Identificador do item. Identifica o item da transação. Este identificador deve ser único por transação e foi informado por você no fluxo de pagamento.
Presença: Obrigatória.
Tipo: Texto.
Formato: Livre.

<transaction>
<items>
<item>
<description>

Descrição do item. Descreve o item da transação. A descrição é um texto explicativo do item que você especificou no fluxo de pagamento.
Presença: Obrigatória.
Tipo: Texto.
Formato: Livre.

<transaction>
<items>
<item>
<amount>

Valor unitário do item. Informa o preço unitário do item da transação. Este é o valor que foi especificado no fluxo de pagamento.
Presença: Obrigatória.
Tipo: Número.
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 transação. Está é a quantidade que foi especificada no fluxo de pagamento.
Presença: Obrigatória.
Tipo: Número.
Formato: Um número inteiro maior ou igual a 1 e menor ou igual a 999.

<transaction>
<sender>
<email>

E-mail do comprador. Informa o e-mail do comprador que realizou a transação.
Presença: Obrigatória.
Tipo: Texto.
Formato: um e-mail válido (p.e., usuario@site.com.br), com no máximo 60 caracteres.

<transaction>
<sender>
<name>

Nome completo do comprador. Informa o nome completo do comprador que realizou o pagamento.
Presença: Opcional.
Tipo: Texto.
Formato: No mínimo duas sequências de caracteres, com o limite total de 50 caracteres.

<transaction>
<sender>
<phone>
<areaCode>

DDD do comprador. Informa o código de área (DDD) do comprador que realizou o pagamento.
Presença: Opcional.
Tipo: Número.
Formato: Um número de 2 dígitos correspondente a um DDD válido.

<transaction>
<sender>
<phone>
<number>

Número de telefone do comprador. Informa o número do telefone do comprador que realizou o pagamento.
Presença: Opcional.
Tipo: Número.
Formato: Um número de 7 a 9 dígitos.

<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 possíveis e seus significados.

CodigoSignificado
1Encomenda normal (PAC).
2SEDEX.
3Tipo de frete não especificado.

Presença: Obrigatória.
Tipo: Número.
Formato: Inteiro.

<transaction>
<shipping>
<cost>

País do endereço de envio. Informa o país do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: No momento, apenas o valor BRA é permitido.

<transaction>
<shipping>
<address>
<state>

Estado do endereço de envio. Informa o estado do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: Duas letras, representando a sigla do estado brasileiro correspondente.

<transaction>
<shipping>
<address>
<city>

Cidade do endereço de envio. Informa a cidade do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: Livre. Deve ser um nome válido de cidade do Brasil, de acordo com os dados dos Correios.

<transaction>
<shipping>
<address>
<postalCode>

CEP do endereço de envio. Informa o CEP do endereço de envio do produto.
Presença: Opcional.
Tipo: Número.
Formato: Um número de 8 dígitos.

<transaction>
<shipping>
<address>
<district>

Bairro do endereço de envio. Informa o bairro do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: Livre.

<transaction>
<shipping>
<address>
<street>

Nome da rua do endereço de envio. Informa o nome da rua do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: Livre.

<transaction>
<shipping>
<address>
<number>

Número do endereço de envio. Informa o número do endereço de envio do produto.
Presença: Opcional.
Tipo: Texto.
Formato: Livre.

Updated 14 days ago

API Consulta


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.