API NepturePay

Integração simples e rápida com sua aplicação

Autenticação

Todas as requisições requerem autenticação via Bearer Token com sua API Key.

Headers

Authorization: Bearer np_sua_api_key_aqui
Content-Type: application/json

Endpoints

POST /api/pix/create

Cria uma nova cobrança PIX.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
description	string	sim	Descrição da cobrança
amount	float	sim	Valor (mín: R$ 4,00)
expires_in	int	não	Minutos até expirar (1-1440)
webhook_url	string	não	URL do webhook personalizado

curl -X POST https://nepturepay.com/api/pix/create \
  -H "Authorization: Bearer np_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Compra de produto",
    "amount": 100.00,
    "expires_in": 30
  }'

$client = new HttpClient();
$response = $client->post('https://nepturepay.com/api/pix/create', [
    'headers' => [
        'Authorization' => 'Bearer np_sua_api_key',
        'Content-Type' => 'application/json',
    ],
    'json' => [
        'description' => 'Compra de produto',
        'amount' => 100.00,
        'expires_in' => 30,
    ],
]);

const response = await fetch('https://nepturepay.com/api/pix/create', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer np_sua_api_key',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        description: 'Compra de produto',
        amount: 100.00,
        expires_in: 30,
    }),
});

import requests

response = requests.post(
    'https://nepturepay.com/api/pix/create',
    headers={
        'Authorization': 'Bearer np_sua_api_key',
        'Content-Type': 'application/json',
    },
    json={
        'description': 'Compra de produto',
        'amount': 100.00,
        'expires_in': 30,
    }
)

POST /api/pix/cancel

Cancela uma cobrança PIX pendente. Requer o external_id da cobrança.

GET /api/pix/status?external_id={uuid}

Consulta o status de uma cobrança PIX pelo external_id.

GET /api/pix/list?status=paid&page=1

Lista todas as cobranças do usuário. Filtro opcional por status.

GET /api/balance

Retorna o saldo disponível e pendente do usuário.

Eventos de Webhook

Configure URLs para receber notificações em tempo real.

payment.created — Cobrança criada

payment.pending — Aguardando pagamento

payment.paid — Pagamento confirmado

payment.expired — Cobrança expirada

payment.cancelled — Cobrança cancelada

withdraw.created — Saque solicitado

withdraw.completed — Saque concluído

withdraw.failed — Saque falhou

Começar a Integrar

Documentação completa disponível em Swagger/OpenAPI