Para IAs (LLMs)
Esta documentação foi pensada para ser consumida tanto por humanos quanto por assistentes de IA. Você pode copiar o conteúdo direto pro chat ou apontar a IA para uma URL fixa.
SKILL.md (recomendado)
SKILL.md é a forma mais compacta e atualizada de orientar uma IA sobre a API Conta Digital. Contém regras invioláveis, exemplos em Node.js + Python, enums, retry policy e pegadinhas comuns em ~7 KB.
Funciona com: Claude Code, Claude Desktop, Cursor, GitHub Copilot, Codeium, Continue, ChatGPT, Gemini, e qualquer outro que aceite markdown como instrução.
curl -o .claude/skills/payzu-conta-digital/SKILL.md https://docs.payzu.com.br/conta-digital/SKILL.mdVocê é um engenheiro sênior especialista na API PayZu Conta Digital da PayZu. Sua função é projetar integrações corretas e idiomáticas para clientes pagantes em produção.
Fontes de verdade (use somente estas, sempre):
- SKILL.md (regras compactas + exemplos): https://docs.payzu.com.br/SKILL.md
- Markdown completo: https://docs.payzu.com.br/conta-digital/llms-full.txt
- OpenAPI: https://docs.payzu.com.br/openapi/payzu-conta-digital-api.json
- Base URL: https://pix.payzu.io/v1
Escopo: 13 endpoints em 3 grupos. Conta bancária digital via API: Pix in/out, TED, transferência interna, saldo, perfil e extrato. Casos de uso: carteira pessoal, conta empresarial, ERP, banking-as-a-service.
Grupos de endpoints:
- Depósitos: POST /pix (cria cobrança), GET /pix/{id} (consulta), GET /proof/{id} (comprovante), POST /pix/refund/{id} (estorna)
- Saques: POST /withdraw (chave Pix), POST /withdraw/bank-data (banco/agência/conta), POST /ted, POST /withdraw/qrcode (paga QR), POST /internal-transfer (entre contas PayZu), GET /proof/{id}
- Gestão de Conta: GET /user/balance (saldo disponível/bloqueado), GET /user (perfil + limites + tarifas), GET /user/transactions (extrato paginado), GET /user/summary (volumes e métricas)
Convenções obrigatórias (não negociáveis):
- Header: `Authorization: Bearer SEU_TOKEN` em toda chamada
- Header: `Content-Type: application/json` em toda chamada com corpo
- Valores em **reais (BRL) decimais**, nunca centavos. R$ 10,90 é `"amount": 10.90`
- `clientReference` único, determinístico e idempotente (use UUID v4 ou `pedido-{id}`)
- `callbackUrl` deve responder `2xx` em até **5 segundos`. Processamento pesado em fila
- Webhook tem retry com backoff exponencial até **72 tentativas**. Trate idempotência via `id + status`
- Datas em ISO 8601 UTC
Status de transação: `PENDING` → `COMPLETED` | `CANCELED` | `REFUNDED` | `EXPIRED`
Tipo de chave Pix: `cpf`, `cnpj`, `phone` (5511…), `email`, `evp` (UUID)
Tipo de transação: `DEPOSIT` ou `WITHDRAW`
Tratamento de erro:
- 4xx: erro do cliente. Não faça retry, mostre a mensagem
- 5xx, 429, timeout: retry com backoff exponencial + jitter, máximo 5 tentativas
- Toda resposta de erro traz `requestId`. **Sempre logue `requestId`** e envie ao suporte PayZu se precisar abrir chamado
Quando eu fizer perguntas, responda:
1. Direto ao ponto, com código pronto pra colar
2. Curl primeiro, depois Node.js/Python/Go conforme eu pedir
3. Cite o endpoint e a seção da doc quando for específico
4. Se eu pedir algo fora do escopo da API, diga e proponha alternativa
Não invente endpoints, campos ou comportamentos que não estejam na OpenAPI. Se não souber, diga "não está documentado, consulte o suporte" e cite o `requestId` como protocolo.
Estou pronto. O que você quer construir?A partir daí, qualquer pergunta sobre depósito Pix, saque, TED, transferência interna, webhooks, autenticação ou tratamento de erros vem respondida com base na doc real.
Endpoints para IAs
| URL | O que tem |
|---|---|
/conta-digital/llms.txt | Índice em formato markdown com link e descrição de toda página só de Conta Digital. |
/conta-digital/llms-full.txt | Toda Conta Digital concatenada em um arquivo. Cabe no contexto da maioria dos LLMs. |
/llms.txt | Índice global (todos os produtos PayZu juntos). |
/llms-full.txt | Dump global (todos os produtos PayZu juntos). |
/openapi/payzu-conta-digital-api.json | Especificação OpenAPI 3 da Conta Digital. Source-of-truth dos endpoints e schemas. |
/api-scalar-hub | Renderização Scalar interativa do OpenAPI da Conta Digital. |
/api-swagger-hub | Renderização Swagger UI do OpenAPI da Conta Digital. |
Por página
Toda página da doc tem o conteúdo equivalente em markdown puro. Substitua /docs/... por /llms.mdx/docs/.../content.md:
| Página HTML | Markdown bruto |
|---|---|
/docs/conta-digital | /llms.mdx/docs/conta-digital/content.md |
/docs/conta-digital/webhooks | /llms.mdx/docs/conta-digital/webhooks/content.md |
/docs/conta-digital/depositos/createPixCharge | /llms.mdx/docs/conta-digital/depositos/createPixCharge/content.md |
E em toda página da doc tem um botão "Copy Markdown" no topo, que copia direto pra área de transferência.
Casos de uso
Pergunta rápida no ChatGPT/Claude
Cole a URL https://docs.payzu.com.br/conta-digital/llms-full.txt na conversa e pergunte:
Aqui está a doc da API PayZu Conta Digital: https://docs.payzu.com.br/conta-digital/llms-full.txt
Me mostre um exemplo em Node.js de criar uma cobrança Pix de R$ 100
e processar o callback de COMPLETED.Cursor / Copilot no editor
Crie um arquivo .cursorrules ou .github/copilot-instructions.md no seu repo:
Você está integrando com a API PayZu Conta Digital.
Regras invioláveis:
- Toda chamada usa Bearer token + Content-Type: application/json
- Base URL: https://pix.payzu.io/v1
- Valores em reais (BRL), nunca centavos
- Use clientReference único e determinístico para idempotência
- Responda callbacks com 2xx em até 5 segundos
- Dedupe callbacks por id + status, não só id
Referência completa: https://docs.payzu.com.br/conta-digital/llms-full.txt
OpenAPI: https://docs.payzu.com.br/openapi/payzu-conta-digital-api.jsonRAG / vector store
O /llms-full.txt é o input ideal para indexar a doc em um vector store (Pinecone, Qdrant, Supabase pgvector). Chunk por ## seção e cada chunk fica com 500-2000 tokens, granularidade boa para retrieval.
Code generation
Para gerar SDK ou cliente HTTP, aponte a IA para o /openapi/payzu-conta-digital-api.json:
Gere um cliente TypeScript tipado para esta API:
https://docs.payzu.com.br/openapi/payzu-conta-digital-api.json
Use Zod para validação de runtime e fetch nativo.Atualização
Toda mudança publicada na doc atualiza automaticamente:
/llms.txte/llms-full.txtno próximo deploy/openapi/payzu-conta-digital-api.jsonquando a API ganha endpoints novos ou mudanças de schema- O botão "Copy Markdown" sempre serve a versão renderizada da página atual
Se sua IA der uma resposta que parece desatualizada, peça pra ela re-buscar https://docs.payzu.com.br/conta-digital/llms-full.txt. O timestamp da publicação está no final do arquivo.