Skip to main content
NU

NuPay

v0.2.1API Key

Nubank's merchant checkout rail — wallet-backed one-click, Pix, and recurrence, backed by Nubank's 100M+ BR customer distribution. Full OpenAPI verified; base platform is Spinpay.

22 tools5 env vars🇧🇷 Brazilstable on npm

What your agent can do

NuPay gives your agent 22 tools it calls directly — pick the ones it needs, in Claude, Cursor, or any MCP client.

  • create_paymentCreate a NuPay checkout payment. Returns pspReferenceId + the redirect/QR payload the shopper needs to complete the charge (NuPay wallet push or Pix). Use merchant-key auth.
  • get_paymentRetrieve full payment details (amount, shopper, items, current status, timestamps) by pspReferenceId. Use this for richer detail than get_payment_status.
  • get_payment_statusRetrieve a payment's status by pspReferenceId.
Example call
// Your agent calls a tool directly — no glue code.
// CodeSpar's managed tier handles OAuth2, token rotation and rate limits.
const result = await session.call("create_payment", { /* ... */ });

Install

terminal
$ npm install @codespar/mcp-nupay

Quickstart

Add this entry to your claude_desktop_config.json (or any MCP-compatible client config).

claude_desktop_config.json
{
  "mcpServers": {
    "nupay": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-nupay"
      ],
      "env": {
        "NUPAY_MERCHANT_KEY": "<your_nupay_merchant_key>",
        "NUPAY_MERCHANT_TOKEN": "<your_nupay_merchant_token>"
      }
    }
  }
}

After restart, your agent can call any of the 22 tools below — try create_payment first.

Environment variables · 5

Required to authenticate the server. Stored encrypted when using CodeSpar managed hosting.

NUPAY_MERCHANT_KEY
required

NuPay X-Merchant-Key issued to your merchant

NUPAY_MERCHANT_TOKEN
requiredsecret

NuPay X-Merchant-Token issued to your merchant

NUPAY_CLIENT_ID
optional

OAuth2/CIBA client_id for pre-authorized (recurrence) flows. Optional unless using backchannel_start / backchannel_complete.

NUPAY_CLIENT_SECRET
optionalsecret

OAuth2/CIBA client_secret for pre-authorized flows. Optional unless using backchannel_* tools.

NUPAY_ENV
optional

sandbox | production. Defaults to sandbox. Drives both checkout API and auth base URLs.

Available tools · 22

Each tool is independent — your agent loads only what it needs to reduce context and response time.

WRITEcreate_payment
Create a NuPay checkout payment. Returns pspReferenceId + the redirect/QR payload the shopper needs to complete the charge (NuPay wallet push or Pix). Use merchant-key auth.
WRITEget_payment
Retrieve full payment details (amount, shopper, items, current status, timestamps) by pspReferenceId. Use this for richer detail than get_payment_status.
WRITEget_payment_status
Retrieve a payment's status by pspReferenceId.
WRITElist_payments_by_date
List payments created within a date range. Supports cursor pagination via limit + offset. Useful for reconciliation and reporting.
DELETEcancel_payment
Cancel a payment that has not yet been captured/settled.
DELETEcreate_refund
Refund a settled payment (full or partial). Idempotent via transactionRefundId.
DELETEget_refund
Retrieve refund status by pspReferenceId + refundId.
READlist_refunds
List all refunds issued against a given payment.

Compatible frameworks

MCP is a protocol — any framework that speaks it can mount this server.

Claude Agent SDKAnthropic
OpenAI AgentsOpenAI
Vercel AI SDKVercel
LangChainLangChain
LlamaIndexLlamaIndex
CrewAICrewAI
MastraMastra
Any MCP clientProtocol

Frequently asked questions

Run `npx -y @codespar/mcp-nupay` and add the config block above to your MCP client — Claude, Cursor, VS Code, or any MCP-compatible client. No build step, no SDK required. Prefer hosted? CodeSpar's managed tier runs it for you with auth handled.
NuPay — MCP server · 22 tools | CodeSpar