GET

Listar Transações

Consulte todas as transações da sua empresa com paginação.

Endpoint

GET/api/v1/transactions

Retorna uma lista paginada de transações

Headers Obrigatórios

Parametro	Tipo	Descricao
`Accept`obrigatorio	`string`	application/json
`X-Client-Id`obrigatorio	`string`	Client ID do seu aplicativo
`X-API-Key`obrigatorio	`string`	Chave secreta da sua empresa

Parâmetros de Query

Parametro	Tipo	Descricao
`page`	`number`	Número da página (padrão: 1)
`limit`	`number`	Quantidade por página (padrão: 20, máx: 100)
`status`	`string`	Filtrar por status (WAITING_PAYMENT, PAID, EXPIRED, CANCELLED)
`startDate`	`string`	Data inicial (ISO 8601)
`endDate`	`string`	Data final (ISO 8601)
`externalId`	`string`	Filtrar por ID externo

Resposta de Sucesso (200 OK)

response.json

json

{
  "data": {
    "items": [
      {
        "id": "f2d96218-6635-4839-81d7-9f2d5aaf4f14",
        "status": "PAID",
        "paymentMethod": "PIX",
        "amount": 500,
        "externalId": "pedido-123",
        "customer": {
          "name": "João Silva",
          "email": "joao@email.com"
        },
        "createdAt": "2025-01-15T15:00:00Z",
        "updatedAt": "2025-01-15T15:10:00Z"
      },
      {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "status": "WAITING_PAYMENT",
        "paymentMethod": "PIX",
        "amount": 1000,
        "externalId": "pedido-124",
        "customer": {
          "name": "Maria Santos",
          "email": "maria@email.com"
        },
        "createdAt": "2025-01-15T16:00:00Z",
        "updatedAt": "2025-01-15T16:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "totalPages": 8
    }
  },
  "status": 200,
  "message": "Transações listadas com sucesso."
}

Campos de Paginação

Parametro	Tipo	Descricao
`pagination.page`	`number`	Página atual
`pagination.limit`	`number`	Itens por página
`pagination.total`	`number`	Total de itens
`pagination.totalPages`	`number`	Total de páginas

Exemplos

cURL

bash

curl -X GET "https://rayopay.com.br/api/v1/transactions?page=1&limit=20&status=PAID" \
  -H "Accept: application/json" \
  -H "X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33" \
  -H "X-API-Key: sua-api-key-secreta"

JavaScript (fetch)

javascript

const params = new URLSearchParams({
  page: '1',
  limit: '20',
  status: 'PAID'
});
 
const response = await fetch(
  `https://rayopay.com.br/api/v1/transactions?${params}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'sua-api-key-secreta'
    }
  }
);
 
const data = await response.json();
console.log(`Total: ${data.data.pagination.total} transações`);
console.log(`Página ${data.data.pagination.page} de ${data.data.pagination.totalPages}`);

Performance

Para grandes volumes de dados, utilize sempre a paginação e filtros para otimizar a performance das requisições.