Consultar transações

Consultar transações

Recipes
🔎
🔎 Consultando uma Venda e suas Transações
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Paginação e filtros

Todos os query params são opcionais. A consulta retorna as Transações da empresa autenticada; filtros de identificadores, documento, opção de pagamento e status usam correspondência exata.

Os padrões são page=1, size=10, sort=created_at e dir=desc. dir depende do envio de sort. Os enums listam valores conhecidos; valores desconhecidos em status e payment_option não têm rejeição por enum garantida.

Em cartão, document_number usa o documento informado para o cartão, com fallback para o comprador. No fluxo de cobrança com cartão verificado, AUTHORISED_TO_VALIDATE pertence a detailed_status e é traduzido para PAID em status.

Valores

Valores monetários são inteiros em centavos (1000 = R$ 10,00). Valores iguais ao mínimo ou ao máximo informado também entram no resultado. amount_end < amount_start retorna HTTP 400 quando ambos são enviados; não há validação equivalente para paid_amount.

Datas

  • Formatos aceitos: YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss, YYYY-MM-DD HH:mm:ss e RFC 3339 com Z ou offset.
  • Sem offset, a interpretação inicial é UTC. Datas sem horário representam meia-noite; _end não se estende ao fim do dia. Registros exatamente nos limites considerados pelo filtro também entram no resultado.
  • created_at_* e updated_at_* somam três horas ao valor interpretado, mesmo com offset. payment_at_* não recebe esse acréscimo.
  • Em cartão, payment_at pode ser a data de criação informada pelo provedor, distinta de captured_at.
  • Datas inválidas podem ser ignoradas, sem erro de validação garantido.
Query Params
string

Filtrar por UUID da Transação.

string

Filtrar por UUID da Venda.

string

Filtrar pelo identificador da Transação no provedor de pagamento.

string

Filtrar pelo identificador externo da Transação.

string
enum

Filtrar pela opção de pagamento da Transação.

Allowed:
string
enum

Filtrar pelo status da Transação, distinto de detailed_status.

Allowed:
string

Filtrar pelo documento armazenado na Transação. Em cartão, pode ser o documento do cartão ou do comprador.

integer

Valor mínimo da Transação, em centavos. Inclui o valor informado.

integer

Valor máximo da Transação, em centavos, incluindo o valor informado. Deve ser maior ou igual a amount_start, quando informado.

integer

Valor pago mínimo, em centavos. Inclui o valor informado.

integer

Valor pago máximo, em centavos. Inclui o valor informado.

string

Filtrar o campo payment_at a partir da data informada, incluindo o limite.

string

Filtrar o campo payment_at até a data informada, incluindo o limite.

string

Filtrar registros criados a partir da data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar registros criados até a data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar atualizações a partir da data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar atualizações até a data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

integer
Defaults to 10

Registros por página: de 10 a 200. Valores fora dessa faixa utilizam 10.

integer
Defaults to 1

Número da página. Valores menores que 1 utilizam a página 1.

string
enum
Defaults to created_at

Campo de ordenação. Valores desconhecidos utilizam created_at.

string
enum
Defaults to desc

Direção da ordenação. Só é considerada quando sort é enviado; apenas asc altera o padrão desc.

Allowed:
Headers
string
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json