Listar Transações

Liste todas as transações da sua conta com suporte a paginação e filtros.

GET/v1/transactions

Lista todas as transações com paginação e filtros opcionais

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Tipo de transação para filtrar`Ex: "CASHIN" ou "CASHOUT"`
`status`	string	Não	Status para filtrar`Ex: "PENDING", "RELEASE", "CANCELLED", "FAILED"`
`page`	number	Não	Número da página para paginação. Padrão: 1`Ex: 1`
`limit`	number	Não	Quantidade de resultados por página (1-100). Padrão: 50`Ex: 50`

Resposta

Detalhes da respostaOs campos amount, netAmount e fee são retornados como string (serialização de Decimal — use parseFloat() antes de calcular). O campo status nesta listagem é retornado em lowercase com mapeamento amigável (pending, paid, cancelled, failed), diferente dos endpoints de criação que retornam o enum interno em uppercase.

Tipos de Transação

Tipo	Descrição
`CASHIN`	Entrada de dinheiro (recebimentos, cobranças PIX)
`CASHOUT`	Saída de dinheiro (saques, transferências)

Status das Transações

Status	Descrição
`PENDING`	Aguardando pagamento/processamento
`RELEASE`	Pago/Liberado (equivalente a "paid" na API simplificada)
`CANCELLED`	Cancelado pelo usuário ou sistema
`FAILED`	Falha no processamento

Paginação

A resposta inclui um objeto pagination com informações para navegar entre páginas:

page: Página atual
limit: Quantidade de itens por página
total: Total de transações que atendem aos filtros
totalPages: Quantidade total de páginas

NavegaçãoPara obter a próxima página, incremente o parâmetro page. Continue até page == totalPages.

Próximo passoVeja como Consultar seu Saldo.

cURL
# Listar todas as transações
curl -X GET "https://api.ActivePayments.com.br/api/v1/transactions" \
  -H "Authorization: ApiKey ActivePayments_pk_xxx:ActivePayments_sk_xxx"

# Com filtros
curl -X GET "https://api.ActivePayments.com.br/api/v1/transactions?type=CASHIN&status=RELEASE&page=1&limit=20" \
  -H "Authorization: ApiKey ActivePayments_pk_xxx:ActivePayments_sk_xxx"

Node.js (fetch)
// Listar transações com filtros
const params = new URLSearchParams({
  type: 'CASHIN',
  status: 'RELEASE',
  page: '1',
  limit: '50',
});

const response = await fetch(`https://api.ActivePayments.com.br/api/v1/transactions?${params}`, {
  headers: {
    'Authorization': `ApiKey ${publicKey}:${secret}`,
  },
});

const { data, pagination } = await response.json();

console.log(`Total de transações: ${pagination.total}`);
console.log(`Página ${pagination.page} de ${pagination.totalPages}`);

data.forEach(tx => {
  console.log(`${tx.customerName}: R$ ${tx.amount} - ${tx.status}`);
});

Response 200 OK
{
  "success": true,
  "data": [
    {
      "chargeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "externalId": "txid_abc123xyz",
      "type": "CASHIN",
      "method": "PIX",
      "amount": "150.50",
      "netAmount": "145.99",
      "fee": "4.51",
      "status": "paid",
      "customerName": "João da Silva",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "paidAt": "2024-01-15T10:05:23.000Z"
    },
    {
      "chargeId": "b2c3d4e5-f6g7-8901-bcde-fg2345678901",
      "externalId": "txid_def456abc",
      "type": "CASHIN",
      "method": "PIX",
      "amount": "89.90",
      "netAmount": "86.97",
      "fee": "2.93",
      "status": "pending",
      "customerName": "Maria Santos",
      "createdAt": "2024-01-15T11:30:00.000Z",
      "paidAt": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 127,
    "totalPages": 3
  }
}