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

3 endpoints

Crie, consulte e liste transações na plataforma.

Conta

2 endpoints

Consulte o saldo e realize saques da sua conta.

Callbacks (Webhooks)

5 endpoints

Eventos enviados automaticamente para a URL cadastrada na sua credencial quando o status de uma transação muda. O corpo inclui `transaction.institution` quando a adquirente informa a instituição (SPI), e `payer` com `name` e `document` **mascarado** (mesmo padrão do GET /transaction): em CASH_IN é o pagador do Pix; em CASH_OUT, quando a adquirente envia dados de liquidação, o favorecido. `payer` pode ser `null` se os dados ainda não estiverem disponíveis.