Documentation Index — nucleopay.com.br/llms.txt

SDKs

Bibliotecas oficiais para integrar PIX com menos boilerplate.

TypeScript / Node — @nucleopay/sdk

npm i @nucleopay/sdk

Ou use o bundle no site: /js/nucleopay-sdk.js (ESM).

import { NucleoPayClient } from "@nucleopay/sdk";

const np = new NucleoPayClient({
  token: process.env.NUCLEOPAY_API_TOKEN, // ncp_prod_… ou np_test_…
});

const charge = await np.createPixCharge({
  value: 49.9,
  title: "Plano Pro",
  idempotencyKey: "order-42",
});

// Sandbox
if (np.isTestMode) await np.simulatePay(charge.chargeId);

Embed no frontend

Não envie o token Bearer ao browser. Crie a cobrança no backend e monte o widget:

<script src="https://nucleopay.com.br/js/nucleopay-embed.js"></script>
NucleoPayEmbed.mount("#pix", {
  brCode, qrCodeImage, chargeId,
  statusUrl: "/api/meu-app/status?id=" + chargeId,
  onApproved: () => {}
});

Disponíveis hoje

LinguagemStatusPacote
Node.js / TypeScriptDisponível@nucleopay/sdk
Browser embedDisponível/js/nucleopay-embed.js
PythonCLI + MCP + clientpython -m nucleopay_cli
PHP / GoREST + exemplosDocs / referência

Python (MCP / CLI)

git clone https://github.com/nucleocompany/Nucleo-pay-API-SERVERS.git
cd Nucleo-pay-API-SERVERS
python -m pip install -e .
python -m nucleopay_cli pix create --value 49.9 --title "Meu produto"

Quickstart SaaS

Fluxo completo em 5 minutos.

MCP HTTP

POST /api/integrations/mcp/call

Demo

Explore sem conta.