Listar pagamentos
Retorna uma lista paginada de pagamentos vinculados aos eventos autorizados pela chave de API. **Permissão exigida:** `data`. **Comportamento:** - Pagamentos sem `amount` ou sem `paymentMethod` são excluídos automaticamente — `pagination.total` reflete apenas o que é retornado - A profundidade de paginação está limitada a 10.000 registros (`page × limit ≤ 10000`) - Intervalo `[startDate, endDate]` não pode exceder 365 dias - Valores monetários são JSON numbers (float) preservando centavos
Authorization
ApiKeyAuth dataChave de API enviada no header.`.
Permissões (scopes):
data— leitura de dados (ex:GET /payments)validation— operações de validação (ex: check-in)
Cada rota documenta os scopes exigidos. Uma chave sem o scope necessário recebe 401.
In: header
Scope: data
Query Parameters
Filtra pagamentos pelos aliases dos eventos. Aceita repetição do parâmetro: ?eventAliases=a&eventAliases=b. Cada alias deve pertencer aos eventos autorizados da chave de API; um único alias inexistente, inativo ou fora do escopo retorna 403.
Filtrar pagamentos criados a partir desta data (ISO-8601, inclusive).
date-timeFiltrar pagamentos criados até esta data (ISO-8601, inclusive).
date-timeFiltrar por status do pagamento. Retorna todos quando omitido.
"RESERVED" | "PENDING" | "APPROVED" | "CANCELLED" | "REJECTED" | "EXPIRED" | "CHARGEBACK"Filtrar por método de pagamento. Retorna todos quando omitido.
"PIX" | "CREDITCARD" | "BOLETO" | "INTL_CREDITCARD" | "DEBITCARD" | "WALLET"Número da página (1-indexed). Default: 1.
^\d+$Itens por página. Mínimo 1, máximo 100. Default: 50.
^\d+$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/public/v1/public/v1/payments"{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"createdAt": "2026-03-15T10:00:00.000Z",
"status": "APPROVED",
"paymentMethod": "PIX",
"mode": "ONLINE",
"installments": null,
"amount": {
"value": 100.5
},
"event": {
"id": 100,
"alias": "festival-xyz",
"name": "Festival XYZ"
},
"buyer": {
"name": "João Silva",
"email": "joao@example.com",
"phone": "+5511999999999",
"gender": "MALE",
"birthDate": "1990-01-15T00:00:00.000Z"
},
"items": [
{
"quantity": 1,
"unitPrice": 100.5,
"subtotal": 100.5,
"ticketName": "Pista 1º Lote",
"discount": null
}
],
"coupon": null
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 1,
"hasMore": false
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters"
}
}{
"error": {
"code": "API_KEY_MISSING",
"message": "Missing X-API-Key header"
}
}{
"error": {
"code": "ROUTE_TYPE_NOT_PERMITTED",
"message": "Access denied: route type not permitted for this API key"
}
}{
"message": "Too many requests. Try again later."
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal Server Error"
}
}