Skip to main content

SDKs and tools

The coordinates below point to public, immutable releases. Each release was confirmed in its registry and validated through a clean install or resolution before being listed here.

MuPag coordinates​

EcosystemPublic coordinateStatus
Node.js/TypeScriptmupag-sdk@0.2.0Published on npm and validated through a clean install
Pythonmupag-sdk==0.2.0Published on PyPI and validated through a clean install
Python compatibilitymupay-sdk==0.2.0Published legacy bridge; installs mupag-sdk==0.2.0 and emits DeprecationWarning
Java corebr.com.mupag:mupag-sdk:0.2.0Published on Maven Central and validated through a clean resolution
Java Spring Bootbr.com.mupag:mupag-sdk-spring-boot-starter:0.2.0Published on Maven Central and validated through a clean resolution
Java core compatibilitybr.com.mupay:mupay-sdk:0.2.0Published legacy POM; relocates to br.com.mupag:mupag-sdk:0.2.0
Java Spring Boot compatibilitybr.com.mupay:mupay-sdk-spring-boot-starter:0.2.0Published legacy POM; relocates to br.com.mupag:mupag-sdk-spring-boot-starter:0.2.0
Gogithub.com/mupaybr/mupag-sdk-go@v0.2.0Published through the Go proxy and pkg.go.dev
PHPmupag/mupag-sdk:^0.2.0Published on Packagist from the dedicated repository
Widget@mupag/widget@0.1.1Published on npm; versioned bundles available from unpkg and jsDelivr

The @mupag/mcp-server@0.1.0 MCP server and its discovery channels are documented in AI integration.

Create a PIX charge with your SDK​

Choose your language and call mupag.charges.create or the equivalent SDK method:

Installationnpm install mupag-sdk@0.2.0
import { MuPag } from 'mupag-sdk';

const mupag = new MuPag({
apiKey: process.env.MUPAG_API_KEY,
env: 'test',
});

const charge = await mupag.charges.create({
amount_cents: 1290,
payment_method: 'pix',
customer: {
name: 'Ana Silva',
email: 'ana@example.com',
tax_id: '12345678909',
},
}, { idempotencyKey: 'order_123_charge_1' });

console.log(charge.charge_id);

Keep the secret key on the backend. The SDK generates an Idempotency-Key; for distributed retries, provide and persist one stable key for the same intent.

Public artifacts and source​

  • Public OpenAPI for generation and validation
  • Postman collection published on this portal, limited to the public OpenAPI, with no filled-in secrets
  • llms.txt and llms-full.txt for AI tooling
  • Source, tests, examples, and releases for the Go and PHP SDKs in their dedicated public repositories

The remaining source and issue trackers stay internal. Public metadata points to this documentation, and the Java POM keeps the private SCM allowed by Maven Central while using this public portal as its project URL.

When you mention a package​

Always use the coordinate and version shown on this page. Do not replace pinned versions with latest in production or agent configurations.

Did this page unblock the next step?

Feedback stays inside the docs flow and should never include customer or card data.

mupag / support

How can we help?

Quick answers, AI and our team.

Frequently asked questions

How do I start integrating?

Follow the quickstart, configure the QA environment and create your first test charge.

Read documentation
My PIX payment is pending. What now?

Confirmation is asynchronous. Check the charge status and webhook events before fulfilling the order.

Read documentation
How do I receive payment notifications?

Register a webhook endpoint, verify its signature and handle duplicate events safely.

Read documentation
How do subscriptions work?

Read the subscriptions guide to configure recurring billing and follow the charge lifecycle.

Read documentation
Where can I find authentication help?

See how to use environment credentials in the documentation. Never share your key in chat.

Read documentation