Naken Pay · API v1

Documentação da API

Referência dos endpoints disponíveis hoje para integração com cobranças Pix, conta e webhooks.

Introdução

A API Naken Pay permite integrar cobranças Pix (cash-in), consulta de saldo, saques (cash-out) e receber webhooks em tempo real quando uma transação muda de status. Todas as rotas são REST, usam JSON e devem ser chamadas apenas por HTTPS.

Esta referência cobre os endpoints públicos atualmente disponíveis. Novos recursos serão publicados aqui à medida que forem lançados.

Autenticação

Cada requisição autenticada deve enviar as credenciais da integração em headers HTTP (geradas no painel em Credenciais da API):

CI — Client ID
CS — Client Secret

Em requisições com corpo, inclua também Content-Type: application/json.

Importante: nunca exponha o Client Secret em aplicativos front-end, repositórios públicos ou links compartilháveis. Use apenas em servidores ou ambientes seguros.

Base URLhttps://api.nakenpay.com/api/v1

Todas as requisições devem usar HTTPS. Requisições HTTP serão redirecionadas automaticamente.

Transações

4 endpoints

Cobranças e consultas via API (CI/CS) e transferência interna entre contas no painel (JWT Bearer).

Conta

2 endpoints

Consulte o saldo e realize saques da sua conta.

Webhooks

5 endpoints

Eventos enviados por **HTTPS POST** para a URL cadastrada no campo “URL de Callback” da credencial (painel → Credenciais). Cabeçalhos: `Content-Type: application/json`, `X-Webhook-Event` e `X-Client-Id` (CI da credencial). Timeout 10s; valide o remetente (IP fixo ou assinatura futura) e use HTTPS na sua URL. Transações: corpo com `transaction` e `payer`.