Skip to main content
GET
/
transactions
Listar Transações
curl --request GET \
  --url https://api.example.com/transactions \
  --header 'Authorization: <authorization>'
{
  "object": "list",
  "data": [
    {
      "id": "ch_flare_dc7dc11b7f984d2886d2b429",
      "object": "charge",
      "amount": 10.00,
      "amount_cents": 1000,
      "currency": "BRL",
      "status": "paid",
      "description": "Pedido #1234",
      "customer": {
        "name": "João Silva",
        "email": "joao@email.com"
      },
      "fee": {
        "amount": 0.50,
        "net_amount": 9.50
      },
      "created_at": "2026-03-05T18:14:48.552Z",
      "paid_at": "2026-03-05T18:16:22.000Z",
      "livemode": true
    }
  ],
  "has_more": true,
  "url": "/v1/transactions"
}

Descrição

Retorna uma lista paginada de transações (cobranças e saques) com suporte a filtros por tipo, status e data.

Headers

Authorization
string
required
Bearer token de autenticação. Formato: Bearer flare_xxx

Query Parameters

limit
integer
default:"10"
Quantidade de resultados (mín: 1, máx: 100)
starting_after
string
Cursor de paginação: ID da última transação da página anterior
type
string
Filtrar por tipo: charge ou withdrawal
status
string
Filtrar por status: pending, paid, expired, failed, processing
created[gte]
string
Data mínima de criação (ISO 8601)
created[lte]
string
Data máxima de criação (ISO 8601)

Exemplo de Requisição

# Listar as últimas 20 cobranças pagas
curl "https://api.flarepayments.com/v1/transactions?limit=20&type=charge&status=paid" \
  -H "Authorization: Bearer flare_sua_chave_aqui"

Resposta 200 OK

object
string
Sempre "list"
data
array
Lista de transações
has_more
boolean
true se existem mais resultados
url
string
URL do endpoint
{
  "object": "list",
  "data": [
    {
      "id": "ch_flare_dc7dc11b7f984d2886d2b429",
      "object": "charge",
      "amount": 10.00,
      "amount_cents": 1000,
      "currency": "BRL",
      "status": "paid",
      "description": "Pedido #1234",
      "customer": {
        "name": "João Silva",
        "email": "joao@email.com"
      },
      "fee": {
        "amount": 0.50,
        "net_amount": 9.50
      },
      "created_at": "2026-03-05T18:14:48.552Z",
      "paid_at": "2026-03-05T18:16:22.000Z",
      "livemode": true
    }
  ],
  "has_more": true,
  "url": "/v1/transactions"
}

Paginação

A API usa cursor-based pagination com o campo starting_after:
// Buscar todas as transações automaticamente
async function buscarTodasTransacoes() {
  const transacoes = [];
  let cursor = null;

  do {
    const params = new URLSearchParams({ limit: '100' });
    if (cursor) params.set('starting_after', cursor);

    const res = await fetch(`https://api.flarepayments.com/v1/transactions?${params}`, {
      headers: { 'Authorization': 'Bearer flare_xxx' }
    });
    const { data, has_more } = await res.json();

    transacoes.push(...data);
    cursor = has_more ? data[data.length - 1].id : null;
  } while (cursor);

  return transacoes;
}
Quando has_more é true, existem mais resultados. Use o id da última transação retornada como starting_after para buscar a próxima página.