Skip to main content
N

NuPay

@codespar/mcp-nupay · v0.2.2

🇧🇷 BrazilPaymentsAuth · API Keybeta22 tools3 env vars

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.

Get started · freeView docs

MIT · runs locally with your own credentials

Limitations

  • The package manifest declares NUPAY_CLIENT_ID, NUPAY_CLIENT_SECRET, which the code does not read.
  • Hosted calls with a test key are not available: the runtime has not recorded this provider's test behaviour (test venue unclassified).
Package
@codespar/mcp-nupay
Version
0.2.2
npm dist-tag
latest
Category
Payments
Auth
API Key
Country
🇧🇷 Brazil
License
MIT
Transport
stdio · streamable-http

Quickstart

Install, set the credentials, make the first call.

Pick your client. The server runs locally over stdio, with your own credentials.

Add the server to your clientOne config entry. No build step, no SDK required.
Set the environment variables3 variables read by this server's code, listed below.
Restart and make the first callThe agent can call any of the 22 tools. Try create_payment first.
terminal
# Claude Code claude mcp add nupay -e NUPAY_ENV=… -e NUPAY_MERCHANT_KEY=… -e NUPAY_MERCHANT_TOKEN=… -- npx -y @codespar/mcp-nupay@0.2.2 # then: /mcp to confirm the server is connected
Environment variables3 variables
NUPAY_ENVsandbox | production. Defaults to sandbox. Drives both checkout API and auth base URLs.optional
NUPAY_MERCHANT_KEYNuPay X-Merchant-Key issued to your merchantrequired
NUPAY_MERCHANT_TOKENNuPay X-Merchant-Token issued to your merchantrequiredsecret

Names read from the package code (@codespar/mcp-nupay@0.2.2). Descriptions and flags come from its manifest. Self-hosted, you hold the credentials.

First call democreate_payment

"Create a NuPay checkout payment. Returns pspReferenceId + the redirect/QR payload the shopper needs to complete the charge"

tools/callcreate_paymentresult returned

Tools

What your agent can call.

22 tools, as the package's tools/list returns them.

create_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.

get_payment

Retrieve full payment details (amount, shopper, items, current status, timestamps) by pspReferenceId. Use this for richer detail than get_payment_status.

get_payment_status

Retrieve a payment's status by pspReferenceId.

list_payments_by_date

List payments created within a date range. Supports cursor pagination via limit + offset. Useful for reconciliation and reporting.

cancel_payment

Cancel a payment that has not yet been captured/settled.

create_refund

Refund a settled payment (full or partial). Idempotent via transactionRefundId.

get_refund

Retrieve refund status by pspReferenceId + refundId.

list_refunds

List all refunds issued against a given payment.

create_recipient

Register a final beneficiary (required for regulatory split payments). Up to 10 recipients can later be attached to a payment.

get_recipient

Retrieve a registered recipient by referenceId.

update_recipient

Update a registered final beneficiary (name, document, country, type). referenceId is the path key and cannot be changed.

delete_recipient

Remove a registered recipient. Will fail if the recipient is currently attached to in-flight payments.

Names and descriptions come from the package's tools/list (@codespar/mcp-nupay@0.2.2). A kind (read, write, delete) is shown only when the package annotates its tools or each tool was verified one by one; neither exists for this server yet.

Compatibility

MCP is a protocol. Any client that speaks it can mount this server.

codespar_discover lists this server's tools, but a project with a test key cannot call them yet: the runtime has not recorded what this provider does in test mode, and refuses rather than guess.

Protocol

Any MCP client

stdio · streamable-http

Questions

Before you install.

How do I install the NuPay MCP server?

Run npx -y @codespar/mcp-nupay@0.2.2 and add the config block above to your MCP client: Claude Code, Cursor, Claude Desktop, VS Code, or any MCP-compatible client. No build step, no SDK required.

What can my agent do with NuPay?

NuPay exposes 22 tools for payments. Your agent calls them directly; the full list is above.

How does NuPay authenticate, and how are credentials stored?

NuPay uses API Key. Self-hosted, you hold the credentials: the server reads them from its environment variables.

How does NuPay handle upstream API changes?

Every server is versioned independently on npm. The command on this page pins 0.2.2, the version whose tools are listed here; your agent keeps running it until you change the version.

Is NuPay open source? How do I report a bug?

Yes. NuPay is MIT-licensed and published on npm as @codespar/mcp-nupay, source on GitHub (link in the Details panel). Report issues on the package repository; security issues go to security@codespar.dev, and we respond within 24 hours.

Start in seconds.

Add the config above, set the variables, and your agent calls the tools.

Start in seconds demo
Add the server to your client with the config above.
Set the environment variables listed above.
Ask your agent for the first call.
NuPay — MCP server · 22 tools | CodeSpar