Listar transações

GEThttps://{apiUrl}/transactions

Atualizado em 26 de setembro de 2025 · 2 min de leitura

Consulta transação

Endpoint: GET https://{apiUrl}/transactions

Lista as transações de um período. O intervalo máximo entre begin_date e end_date é de 3 meses.

Parâmetros de query

GEThttps://{apiUrl}/transactions

URL base da API

Token de autenticação

Query Params

begin_datestringrequired

Data inicial no formato YYYY-MM-DD

end_datestringrequired

Data final (máx. 3 meses após begin_date)

pageintegeroptional

Número da página (default: 1)

payment_methodstringoptional

Filtrar por: "credit_card", "pix" ou "boleto"

statusstringoptional

Filtrar por status (ex: paid, pending, failed)

curl --request GET \
  --url "https://{apiUrl}/transactions"

Response

Choose an example:

application/json

Exemplo de resposta

json

{
  "total": 1,
  "per_page": 100,
  "page": 1,
  "data": [
    {
      "id": "08aab959-868d-40a9-9ea6-c9e539fe9d4e",
      "type_operation": "online",
      "created_at": "2025-02-17 16:54:34",
      "amount": 100,
      "liquid_amount": 90,
      "status": "paid",
      "payment_method": "credit_card",
      "customer_name": "João da Silva"
    }
  ]
}

Campos da resposta

totalinteger

Total de transações encontradas no período

per_pageinteger

Número de itens por página

pageinteger

Página atual

dataarray

Lista de transações

data[].idstring

UUID da transação

data[].type_operationstring

Tipo: online, presencial, etc.

data[].created_atstring

Data de criação

data[].amountfloat

Valor bruto em reais

data[].liquid_amountfloat

Valor líquido após taxas

data[].statusstring

Status: paid, pending, failed, etc.

data[].payment_methodstring

Método: credit_card, pix, boleto

data[].customer_namestring

Nome do cliente pagador

Esta página foi útil?