RAYO
PIX

Listar Transacoes

Liste todas as transacoes PIX da sua conta com filtros e paginacao.

Endpoint

GET/api/v1/transactions

Retorna uma lista paginada de transacoes

Parametros de Query

ParametroTipoDescricao
page
numberNumero da pagina (padrao: 1)
limit
numberQuantidade por pagina (padrao: 20, max: 100)
status
stringFiltrar por status (WAITING_PAYMENT, PAID, EXPIRED, CANCELLED)
startDate
stringData inicial (ISO 8601)
endDate
stringData final (ISO 8601)
externalId
stringFiltrar por ID externo

Exemplo de Requisicao

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

Resposta de Sucesso

Status Code: 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",
"cpfCnpj": "12345678900"
},
"createdAt": "2024-01-15T15:00:00Z",
"updatedAt": "2024-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",
"cpfCnpj": "09876543210"
},
"createdAt": "2024-01-15T16:00:00Z",
"updatedAt": "2024-01-15T16:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
}
},
"status": 200,
"message": "Transações listadas com sucesso."
}

Paginacao

ParametroTipoDescricao
pagination.page
numberPagina atual
pagination.limit
numberItens por pagina
pagination.total
numberTotal de itens
pagination.totalPages
numberTotal de paginas

Exemplos de Codigo

Node.js / JavaScript

node.js
javascript
async function listTransactions(page = 1, status = null) {
const params = new URLSearchParams({
page: page.toString(),
limit: '20'
});
if (status) {
params.append('status', status);
}
const response = await fetch(
`https://rayopay.com.br/api/v1/transactions?${params}`,
{
method: 'GET',
headers: {
'X-Client-Id': process.env.RAYO_CLIENT_ID,
'X-API-Key': process.env.RAYO_API_KEY,
'Accept': 'application/json'
}
}
);
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}`);
return data.data;
}
// Listar todas as transações pagas
const paidTransactions = await listTransactions(1, 'PAID');

Performance

Para grandes volumes de dados, utilize sempre a paginacao e filtros para otimizar a performance das requisicoes.