# Comece por aqui (/docs)



Esta é a documentação da API pública da Gandaya. Aqui você encontra tudo que precisa para integrar com nossos serviços e começar a consumir dados de pagamentos, eventos e mais.

## URL Base [#url-base]

Todas as chamadas devem ser feitas para a URL base abaixo:

| Ambiente | URL                                   |
| -------- | ------------------------------------- |
| Produção | `https://api.gandaya.dance/public/v1` |

## Autenticação [#autenticação]

A API utiliza autenticação via **API Key**. Todas as requisições devem incluir o header `X-API-Key` com sua chave:

```bash
curl -X GET "https://api.gandaya.dance/public/v1/payments" \
  -H "X-API-Key: gd_a1b2c3d4_..."
```

Cada chave tem um conjunto de **scopes** que determinam quais rotas podem ser acessadas:

* `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`.

## Como conseguir sua Chave de API [#como-conseguir-sua-chave-de-api]

As chaves de API são gerenciadas pelo painel administrativo da Gandaya. Para obter a sua:

1. Acesse o painel administrativo da sua organização
2. Vá em **Configurações**
3. Crie uma nova chave de API, selecionando os **eventos autorizados**

Cada chave está vinculada a uma organização e a um conjunto específico de eventos. Requisições que tentarem acessar dados de eventos não autorizados retornarão erro `403`.

## Formato de Resposta [#formato-de-resposta]

### Sucesso [#sucesso]

As respostas de sucesso retornam o recurso diretamente, sem envelope:

```json
{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 120,
    "hasMore": true
  }
}
```

### Erro [#erro]

Em caso de erro, a resposta segue o formato:

```json
{
  "error": {
    "code": "API_KEY_INVALID",
    "message": "The provided API key is not valid"
  }
}
```

Os principais códigos de erro são:

| Código                     | HTTP Status | Descrição                                      |
| -------------------------- | ----------- | ---------------------------------------------- |
| `VALIDATION_ERROR`         | 400         | Parâmetros inválidos                           |
| `INVALID_QUERY`            | 400         | Query inválida (ex: `eventAliases` malformado) |
| `API_KEY_MISSING`          | 401         | Header `X-API-Key` ausente                     |
| `API_KEY_INVALID`          | 401         | Chave de API inválida                          |
| `API_KEY_INACTIVE`         | 401         | Chave de API revogada/desativada               |
| `ROUTE_TYPE_NOT_PERMITTED` | 403         | Chave sem permissão para esta rota             |
| `EVENT_NOT_AUTHORIZED`     | 403         | Evento fora do escopo desta chave              |
| `INTERNAL_ERROR`           | 500         | Erro interno do servidor                       |

Requisições que excederem o limite de taxa retornam `429` com `{ "message": "Too many requests. Try again later." }` (sem campo `code`).

## Headers Padrão [#headers-padrão]

Todas as respostas incluem `Cache-Control: no-store` por padrão.

## Valores Monetários [#valores-monetários]

Os valores monetários são retornados como **strings** (ex: `"149.99"`) para preservar precisão decimal.

## Suporte [#suporte]

Em caso de dúvidas ou problemas com a integração, entre em contato com o time de engenharia da Gandaya.


# Listar pagamentos (/docs/api/get-public-v1-payments)



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document="&#x22;./openapi.json&#x22;" operations="[{&#x22;path&#x22;:&#x22;/public/v1/payments&#x22;,&#x22;method&#x22;:&#x22;get&#x22;}]" />