Documentação
Visão geral
A API da PhanterPay é REST sobre HTTPS, com corpo e resposta em JSON snake_case. Toda requisição é autenticada por chave de API. Criar uma cobrança exige amount no corpo e o header Idempotency-Key.
Base URL
BASEhttps://api.phanterpay.com.br/v1
Contrato estável
Respostas sempre em snake_case, IDs prefixados (chg_, pyt_) e envelope de erro único.
Autenticação
Chaves de API com escopos específicos para cada recurso.
Idempotência
Idempotency-Key obrigatória em POST /charges; external_id deduplica cobranças e é obrigatório em saques.
Integração assistida por IA
Prompts prontos para ChatGPT, Claude, Gemini e outros modelos gerarem integrações alinhadas ao contrato da API.
Convenções
| Item | Regra |
|---|---|
| Formato | JSON em snake_case na requisição e na resposta |
| Valores | Números decimais em reais (150.00), nunca centavos em string |
| Mínimo | R$ 2,00 por cobrança e por saque |
| Datas | ISO 8601 em UTC (2026-01-31T12:00:00.000Z) |
| IDs | chg_ para cobranças, pyt_ para saques, inf_ para infrações, evt_ para eventos |
| Paginação | Cursor: limit + starting_after (sem offset) |
| request_id | Presente em toda resposta de erro e no header x-request-id |
Pronto para integrar?
O Início rápido mostra a autenticação, a criação da cobrança e a consulta do pagamento passo a passo.
Esta página foi útil?
Sua opinião nos ajuda a melhorar nossa documentação.