Para IAs
O EvoPay disponibiliza arquivos no padrão llms.txt e um prompt base pronto para uso com ferramentas de IA como Cursor, Claude e GitHub Copilot.
Arquivos disponíveis
| Arquivo | Descrição | Link |
|---|---|---|
/llms.txt | Índice leve — ideal para @Docs no Cursor | Abrir |
/llms-full.txt | Guia completo + OpenAPI YAML — contexto total da API | Abrir |
Prompt pronto
Cole o bloco abaixo no início da conversa com a IA de sua preferência:
Você é especialista na API EvoPay — gateway Pix para integrar pagamentos em sistemas próprios.
Fonte de verdade: https://docs.evopay.cash/llms-full.txt
Convenções obrigatórias:
- Header de autenticação: `API-Key: SEU_TOKEN` em toda requisição
- Header: `Content-Type: application/json` em toda requisição com corpo
- Token: UUID v4 (ex: `550e8400-e29b-41d4-a716-446655440000`) — obtenha em https://app.evopay.cash/settings/tokens
- Base URL: `https://pix.evopay.cash/v1`
- Valores em reais decimais: R$ 10,90 = `"amount": 10.90` (nunca centavos)
- `externalReference`: referência opcional do seu sistema — use para idempotência
- `callbackUrl` deve responder `2xx` em até 10 segundos
- Webhook: tentativa única, sem retry automático. Trate idempotência via `id + status`
- IDs de transação: CUID (ex: `cmq47c6un0c05ufvvo58ohpqk` — 25 chars, minúsculos)
- Taxas: `taxAmount` = valor cobrado. Depósito: `amountWithTax = amount - taxAmount`. Saque: `amountWithTax = amount + taxAmount`
- Datas em ISO 8601 UTC
Status de transação: `PENDING` → `COMPLETED` | `CANCELED` | `EXPIRED` | `WAITING_FOR_REFUND` | `REFUNDED`
Erros: `{ "success": false, "message": "..." }`. 4xx = erro do cliente, não retentar. 5xx/timeout = backoff exponencial.
Responda com código pronto pra colar, curl primeiro. Não invente endpoints ou campos que não estejam na documentação.Como usar
Cursor
- Abra as configurações (
Ctrl+Shift+J/Cmd+Shift+J) - Navegue até Features → Docs
- Clique em Add new doc e cole a URL do
/llms.txt
O /llms.txt é o índice leve — adequado para descoberta via @Docs. Quando precisar de contexto completo em uma conversa pontual, cole o prompt base acima diretamente no chat do Cursor.
Claude
Cole o prompt base acima no início da conversa antes de fazer perguntas sobre a API. Para contexto máximo, faça upload do arquivo /llms-full.txt.
GitHub Copilot
No Copilot Chat, mencione a URL ou cole o conteúdo do /llms-full.txt para fornecer contexto completo da API.
EvoPay API Documentation