Logo
API Reference

Listar finanças

Retorna o saldo e dados financeiros (receita, saques e balance) por evento.

GET
/public/v1/finances

Authorization

ApiKeyAuth data
X-API-Key<token>

Chave 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

eventAliases?array<string>

Filtra a resposta 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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.gandaya.danca/public/v1/public/v1/finances"

{
  "data": [
    {
      "event": {
        "alias": "festival-xyz",
        "name": "Festival XYZ"
      },
      "revenue": {
        "online": 50000,
        "cashback": 2500,
        "pos": 12000,
        "resales": 800,
        "externalPayments": 0
      },
      "withdrawals": {
        "approvedTotal": 30000,
        "pendingTotal": 5000,
        "items": [
          {
            "createdAt": "2026-03-20T14:30:00.000Z",
            "status": "APPROVED",
            "type": "INTERNAL",
            "amount": 30000,
            "title": "Repasse semanal",
            "description": "Pagamento referente à semana 12"
          },
          {
            "createdAt": "2026-03-27T10:05:00.000Z",
            "status": "PENDING",
            "type": "INTERNAL",
            "amount": 5000,
            "title": "Repasse semanal",
            "description": null
          }
        ]
      },
      "balance": {
        "gross": 64800,
        "withdrawn": 30000,
        "available": 26300,
        "retained": 3500,
        "retentionRate": 0.1,
        "retentionPeriod": 30,
        "isWithinRetentionWindow": true
      }
    }
  ]
}

{
  "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"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Try again later."
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal Server Error"
  }
}

Listar pagamentos GET

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 - Intervalo `[startDate, endDate]` não pode exceder 365 dias - Valores monetários são JSON numbers (float) preservando centavos

llms.txt

Next Page