Listar transações

Lista transações de recebimento com paginação e filtros por status, período e externalId.

Overview

Resposta paginada. Use page e limit; pagination.total e pagination.totalPages indicam o total de páginas.

Endpoint

GETGET /transactions

Base URL:https://api.onnixpay.com/api/v1/sdk

Headers

Header	Obrigatório	Descrição
X-API-Key	Sim	Sua API Key.

Query Parameters

Campo	Tipo	Obrigatório	Descrição	Enum	Exemplo
page	number	Não	Número da página. Padrão: 1.	—	1
limit	number	Não	Itens por página. Padrão: 20, máx: 100.1–100.	—	20
status	string	Não	Filtrar por status (ex.: pending, completed, failed).	—	completed
startDate	string	Não	Data inicial do período (ISO 8601).	—	2025-02-01T00:00:00Z
endDate	string	Não	Data final do período (ISO 8601).	—	2025-02-09T23:59:59Z
externalId	string	Não	ID externo (busca exata).	—	pedido-1234

Exemplo cURL

cURL

curl -X GET "https://api.onnixpay.com/api/v1/sdk/transactions?page=1&limit=20&status=completed" \
  -H "X-API-Key: ox_sua_chave_aqui"

Response — Sucesso (200)

JSON

{
  "data": [
    {
      "id": "txn_abc123",
      "status": "completed",
      "amount": 1000,
      "description": "Pedido #1234",
      "externalId": "pedido-1234",
      "createdAt": "2025-02-09T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

Campos da resposta

Campo	Tipo	Descrição
data	array	Lista de transações. Cada item: id, status, amount, description, externalId, createdAt.
pagination	object	page, limit, total, totalPages.

Use page e limit; para a próxima página, repita com page=2.

Status codes e erros comuns

Status	Código	Mensagem
400	INVALID_REQUEST	Parâmetros de query inválidos.
401	INVALID_API_KEY	Chave de API inválida ou ausente.

Exemplo de resposta de erro

JSON

{
  "code": "INVALID_REQUEST",
  "message": "Parâmetros de query inválidos."
}

Headers

X-API-Key: ox_sua_chave_aqui

cURL

curl -X GET "https://api.onnixpay.com/api/v1/sdk/transactions?page=1&limit=20&status=completed" \
  -H "X-API-Key: ox_sua_chave_aqui"

Response (200)

{
  "data": [
    {
      "id": "txn_abc123",
      "status": "completed",
      "amount": 1000,
      "description": "Pedido #1234",
      "externalId": "pedido-1234",
      "createdAt": "2025-02-09T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}