Skip to main content
GET
/
api
/
transactions
Listar Transações
curl --request GET \
  --url https://api.example.com/api/transactions
{
  "data[].customer": {},
  "data[].gateway": {},
  "data[].domain": {},
  "meta": {}
}

​
Listar Transações

Retorna uma lista paginada das transações do projeto, com suporte a filtros por status, período, valor e busca textual.

​
Autenticação

Authorization: Bearer sk_test_xxx

​
Query Parameters

​
page
integer
Número da página. Default: 1.
​
limit
integer
Itens por página (máximo 100). Default: 10.
​
status
string
Filtrar por status. Valores: waiting_payment, processing, paid, expired, cancelled, refunded.
​
customerId
string
Filtrar por ID do cliente (formato CUID).
​
dateFrom
string
Data mínima de criação (ISO 8601).
​
dateTo
string
Data máxima de criação (ISO 8601).
​
amountMin
integer
Valor mínimo em centavos.
​
amountMax
integer
Valor máximo em centavos.
​
search
string
Busca textual por nome do cliente, email ou ID externo. Máximo 200 caracteres.
​
environment
string
Filtrar por ambiente: live ou sandbox.

​
Response (200)

{
  "success": true,
  "data": [
    {
      "id": "clx7a8b9c0d1e2f3g4h5",
      "externalId": "ext_123456",
      "transactionCode": null,
      "status": "paid",
      "amountCents": 10000,
      "product": "Plano Premium",
      "quantity": 1,
      "paidAt": "2026-01-16T10:05:00.000Z",
      "createdAt": "2026-01-16T10:00:00.000Z",
      "updatedAt": "2026-01-16T10:05:00.000Z",
      "customer": {
        "id": "cly1234567890",
        "name": "João Silva",
        "email": "[email protected]"
      },
      "gateway": {
        "id": "clg1234567890",
        "alias": "gateway-principal",
        "providerId": "provider_123",
        "providerName": "Payhub"
      },
      "domain": {
        "id": "cld1234567890",
        "host": "minhaloja.com"
      }
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 10,
    "totalPages": 5
  }
}
​
data[].customer
object
Dados resumidos do cliente (id, name, email).
​
data[].gateway
object
Gateway que processou a transação (id, alias, providerId, providerName).
​
data[].domain
object | null
Domínio de origem da transação. null se não houve domínio.
​
meta
object
Metadados de paginação com total de registros, página atual, limite e total de páginas.

​
Erros

HTTPCódigoDescrição
401ERR_AUTH_009Token inválido

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].