Guia de Integração Rápida

Siga este passo a passo para integrar a NoxPay em seu sistema em menos de 5 minutos.

1. Obter Credenciais

Acesse o menu Desenvolvedores no seu painel, gere um par de chaves (Public & Secret) e guarde sua Secret Key em local seguro.

2. SDK (Node.js)

Se você utiliza JavaScript/Node.js, recomendamos criar um helper simples:

const createPix = async (amount, customer) => {
    const response = await fetch('https://api.noxpay.site/api/pix/create', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'Authorization': 'Bearer YOUR_SECRET_KEY'
        },
        body: JSON.stringify({
            amount: parseFloat(amount), // Importante: Envie como number ou float
            description: 'Venda #123',
            customer
        })
    });
    return await response.json();
}

3. Receber Webhooks

Configure uma URL em seu painel para receber notificações de pagamento. A NoxPay fará um POST com o status atualizado.

API Reference

Bem-vindo à documentação oficial da API NoxPay. A URL base da API é:

https://api.noxpay.site/api

Autenticação

Todas as requisições devem ser autenticadas usando o esquema Bearer Token ou chaves de API.

Authorization: Bearer YOUR_API_KEY

Criar Cobrança Pix

Gere um QR Code estático ou dinâmico para recebimento imediato.

Exemplo de Request (cURL)

curl -X POST https://api.noxpay.site/v1/pix/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 150.00,
    "description": "Pedido #12345",
    "customer": {
        "name": "João da Silva",
        "document": "12345678900",
        "email": "joao@email.com"
    }
  }'

Exemplo (Node.js)

const response = await fetch('https://api.noxpay.site/v1/pix/create', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 150.00,
    description: 'Pedido #12345'
  })
});
const data = await response.json();

Resposta Sucesso

{
  "transactionId": "1050",
  "pix": {
    "txid": "77f3ea...",
    "qr_code": "00020126580014BR.GOV.BCB.PIX...",
    "qr_code_base64": "iVBORw0KGgo..."
  }
}

Webhooks

Receba notificações automáticas em seu servidor sempre que um pagamento for confirmado.

Payload de Exemplo

{
  "idTransaction": "123456",
  "typeTransaction": "PIX",
  "statusTransaction": "PAID_OUT",
  "amount": 150.00,
  "requestNumber": "5021" // ID da Transação na NoxPay
}

Status Importantes:

• PAID_OUT: Pagamento recebido com sucesso.
• CHARGEBACK: Pagamento contestado/devolvido.

Real-Time (Socket.io)

Atualize seu frontend instantaneamente sem polling.

Conexão Client-Side

import { io } from 'socket.io-client';
const socket = io('https://api.noxpay.site');

// 1. Conectar e Entrar na Sala da Transação
socket.on('connect', () => {
    socket.emit('join_transaction', transactionId);
});

// 2. Ouvir Confirmação
socket.on('payment_confirmed', (data) => {
    console.log('Pago!', data);
});

Erros

A API utiliza códigos de status HTTP convencionais.

• 200 OK: Sucesso.
• 400 Bad Request: Dados inválidos (ex: CPF incorreto).
• 401 Unauthorized: Token inválido ou expirado.
• 403 Forbidden: Acesso negado. Retornado também quando a conta está PENDING (Aguardando aprovação de documentos).
• 429 Too Many Requests: Limite de requisições excedido.
• 500 Internal Server Error: Erro interno do servidor.