Bem-vindo
A API pague.dev permite integrar o processamento de pagamentos em suas aplicações. Esta documentação cobre todos os endpoints disponíveis para gerenciar clientes, projetos, cobranças, transações e pagamentos PIX.URL Base
Todas as requisições devem ser feitas para:Autenticação
Todos os endpoints requerem autenticação usando chaves de API. Inclua suas credenciais nos headers da requisição:Permissões
Cada chave de API possui permissões granulares que determinam quais endpoints ela pode acessar. As permissões são atribuídas no momento da criação da chave.Permissões disponíveis
| Permissão | Descrição |
|---|---|
FULL_ACCESS | Acesso completo a todos os endpoints da API |
PIX:WRITE | Criar cobranças PIX |
CUSTOMER:WRITE | Criar clientes |
CUSTOMER:READ | Listar e buscar clientes |
PROJECT:WRITE | Criar projetos |
PROJECT:READ | Listar e buscar projetos |
CHARGE:WRITE | Criar cobranças (links de pagamento) |
CHARGE:READ | Listar e buscar cobranças |
TRANSACTION:READ | Buscar transações |
WITHDRAWAL:WRITE | Criar saques via PIX |
METRICS:READ | Obter métricas de receita |
A permissão
FULL_ACCESS concede acesso a todos os endpoints, equivalente a possuir todas as permissões listadas acima.Restrição por IP
Chaves com permissãoFULL_ACCESS ou WITHDRAWAL:WRITE exigem a configuração de IPs permitidos. Requisições originadas de IPs não autorizados serão rejeitadas com erro 403 Forbidden.
Essa restrição existe para proteger operações sensíveis como saques e acesso irrestrito à API.
Recursos Disponíveis
PIX
Criar cobranças PIX
Webhooks
Receber notificações de eventos
Clientes
Gerenciar seus clientes
Projetos
Organizar pagamentos por projeto
Cobranças
Criar e gerenciar cobranças
Transações
Visualizar detalhes de transações