| title | Introdução |
|---|---|
| description | Documentação da API pague.dev |
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.
Todas as requisições devem ser feitas para:
https://api.pague.dev/v1
Todos os endpoints requerem autenticação usando chaves de API. Inclua suas credenciais nos headers da requisição:
{
"X-API-Key": "sua-api-key"
}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ã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 |
ACCOUNT:READ |
Visualizar dados da conta e saldo |
Chaves com permissão FULL_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.
Criar cobranças PIX Receber notificações de eventos Gerenciar seus clientes Organizar pagamentos por projeto Criar e gerenciar cobranças Visualizar detalhes de transações Consultar dados da conta e saldo SDKs oficiais para integração Aplicação React com integração completa