Skip to main content
O repositório PagouAi/examples é um complemento prático e executável desta documentação. Cada fluxo principal da v2 é implementado em sete linguagens usando um cliente HTTP idiomático com o mínimo de dependências — não é um SDK e não é específico de framework, então os mesmos padrões se aplicam a qualquer stack. Cada guia aqui aponta para o diretório e o arquivo de exemplo exatos que o implementam, e cada exemplo aponta de volta para o guia e a operação da referência da API. Use a documentação para entender um fluxo e então vá direto para o código que você pode clonar e executar no sandbox.

Pagamentos

Pix + QR, vouchers, cartão via Payment Element, 3DS, reembolsos totais e parciais, paginação.

Checkout Links

Crie um checkout link e guarde a URL pública retornada como identificador.

Clientes & Assinaturas

Crie ou reutilize um cliente e então crie, consulte e cancele uma assinatura.

Transferências (Pix Out)

Crie, consulte e reconcilie uma transferência; cancele quando o status permitir.

Webhooks

Handlers reais para as famílias de eventos de transação, assinatura e transferência.

Linguagens

Todos os fluxos acima estão implementados em cada uma destas linguagens. Abra o diretório de uma linguagem para ver seu README.md, o .env.example e os subdiretórios por fluxo. A referência em TypeScript também traz uma variante @pagouai/api-sdk ao lado da variante raw-HTTP.

Como executar

1

Obtenha um token de sandbox

Entre no seu painel e crie um token de API de sandbox. Tokens de sandbox e de produção são separados — mantenha-os assim.
2

Escolha uma linguagem e um fluxo

Abra o diretório da linguagem e leia o README.md, então abra o subdiretório do fluxo (por exemplo typescript/payments/).
3

Configure o ambiente

Copie .env.example para .env no diretório da linguagem e defina seu token de sandbox. A base URL usa https://api.sandbox.pagou.ai por padrão.
4

Execute um fluxo

Cada README de fluxo documenta um único comando de execução, o payload de entrada, a resposta relevante e o caminho de erro e recuperação esperado.

Cobertura e segurança

  • A matriz de cobertura é a fonte única da verdade sobre o que cada linguagem implementa.
  • Nenhum exemplo recebe PAN ou CVV no backend — os dados de cartão passam apenas pelo Payment Element para um token pgct_*. As chaves de API são usadas somente no servidor, os fixtures são sintéticos e os logs ocultam segredos.
O repositório está em beta enquanto a área de Exemplos entra no ar e os times donos são atribuídos. Os fluxos em si já estão completos, testados e executáveis hoje.