Install Jentic One Beta

Connect the MuPag Public API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the MuPag Public API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmupag.com.br%2Fmupag" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmupag.com.br%2Fmupag" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with MuPag Public API.

Create a PIX or credit card charge in amount_cents for a new or existing customer, with optional split_rules

Open a hosted checkout session for up to 100 items with success_url and cancel_url

Start a subscription on a plan_id with trial_days, and cancel it immediately or at the end of the period

Refund a charge in full or in part and look up the refund's status

GET STARTED

Start building with MuPag Public API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use MuPag Public API for, with concrete tasks.

★ AI sales agent issuing a PIX charge

An AI agent closing a sale in chat needs to hand the buyer a way to pay without the developer building a PIX integration. Through Jentic the agent searches for 'create a PIX charge', loads the MuPag charge operation with its input schema, and sends amount_cents, payment_method pix, and the customer, with a fresh Idempotency-Key and the merchant key injected at call time. It returns the charge to the buyer and later checks the charge list for its status.

Call POST /v1/charges with amount_cents 15000, payment_method pix, a customer object, and an Idempotency-Key, then read GET /v1/charges filtered by customer_id to confirm it

Hosted checkout for a small online store

A store that does not want to collect payment details itself can redirect buyers to a MuPag-hosted checkout. A checkout session takes the items, a success_url, and a cancel_url, plus an optional customer, coupon, UTM parameters, and an expiry of up to 1440 minutes, defaulting to 30. Hosted checkout sessions currently accept PIX as the allowed payment method.

Call POST /v1/checkout-sessions with two items, success_url and cancel_url on the store domain, and expires_in_minutes 60, and return the session

Recurring billing for a membership

A membership business bills customers each cycle. A subscription is created from a customer_id, a plan_id, and a payment method of PIX or credit card, with optional trial_days and coupon. Cancelling takes a required mode of immediate or end_of_period, so a member who quits keeps access until the period ends.

Call POST /v1/subscriptions with customer_id, plan_id, payment_method credit_card, and trial_days 7; later call POST /v1/subscriptions/{id}/cancel with mode end_of_period

Testing payment flows in the sandbox

Before going live, a developer needs paid and failed outcomes without real money. MuPag's sandbox routes seed minimal merchant test data, mark a sandbox charge as paid or failed through the canonical flow, and bring forward a subscription's next billing cycle, so webhook handlers and reconciliation can be exercised end to end.

Call POST /v1/_test/data/seed, create a charge, then call POST /v1/_test/charges/{id}/simulate-paid with an Idempotency-Key and confirm the status in GET /v1/charges

Key Endpoints

26 endpoints — the mupag public api lets brazilian merchants charge customers by pix or credit card, open hosted pix checkout sessions, and run subscriptions on a plan with optional trial days and coupons.

METHOD

PATH

DESCRIPTION

POST

/v1/charges

Create a PIX or card charge

GET

/v1/charges

List charges

POST

/v1/charges/{chargeId}/refunds

Request a full or partial refund

POST

/v1/checkout-sessions

Create a hosted checkout session

POST

/v1/subscriptions

Create a subscription

POST

/v1/subscriptions/{id}/cancel

Cancel a subscription

POST

/v1/customers

Create a customer

POST

/v1/_test/charges/{id}/simulate-paid

Simulate a paid sandbox charge

POST

/v1/charges

Create a PIX or card charge

GET

/v1/charges

List charges

POST

/v1/charges/{chargeId}/refunds

Request a full or partial refund

POST

/v1/checkout-sessions

Create a hosted checkout session

POST

/v1/subscriptions

Create a subscription

POST

/v1/subscriptions/{id}/cancel

Cancel a subscription

POST

/v1/customers

Create a customer

POST

/v1/_test/charges/{id}/simulate-paid

Simulate a paid sandbox charge

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring MuPag by hand means telling sk_test_ and sk_prd_ bearer keys apart, sending an Idempotency-Key on every write, and switching between the sandbox and production hosts. Through Jentic you install once, import MuPag from the API Directory, store the merchant key once, and your agent calls it.

Permission scoping

MuPag carries the customer and amount for a new charge in the request body, so rules bound which operations your agent may call, not which customer it bills. You choose the operations it may call, so money-moving ones like refunds and subscription cancellation are not included unless you add them.

Credential isolation

Your MuPag merchant key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a PIX charge' or 'refund a payment', and Jentic returns the matching MuPag operation with its input schema, including required fields like amount_cents and the Idempotency-Key header, so the agent builds a valid request.

FAQs

Specific to using MuPag Public API through Jentic.

What authentication does the MuPag Public API use?

The MuPag OpenAPI spec declares two bearer schemes. The merchant API key, sk_test_ for sandbox or sk_prd_ for production, is the default for charges, refunds, checkout sessions, subscriptions, customers, and the sandbox tools. A dashboard session JWT is used instead on the production-activation routes and the CEP lookup. The influencer pre-registration route declares no auth, and the Woovi and Asaas provider webhook receivers check an x-webhook-signature or asaas-access-token header instead of a bearer token. Through Jentic your merchant key is held by your own instance and injected at call time.

Which payment methods does the MuPag API support?

Per the spec, a charge's payment_method is pix or credit_card, and subscriptions take the same two. Hosted checkout sessions accept pix in allowed_payment_methods. Credit card charges use a card_token or saved card_token_id and require payer_ip, and the spec says never to send the raw card number or CVV.

What are the rate limits for the MuPag Public API?

The OpenAPI spec does not state a numeric limit, but it documents HTTP 429 responses for over-limit calls. Check the published spec at https://api.mupag.com.br/openapi.yaml and your merchant dashboard for current limits.

Which host should I call for the MuPag API?

The spec lists https://api.sandbox.mupag.com.br for testing with sk_test_ keys and https://api.mupag.com.br for production, which the spec marks as reserved until your merchant account completes production activation.

How do I create a PIX charge through Jentic?

Search Jentic for 'create a PIX charge', load POST /v1/charges, and execute it with amount_cents, payment_method set to pix, a customer, and an Idempotency-Key header. To run it on your own infrastructure, install Jentic One from its GitHub repo.

Can I limit what my agent is allowed to do with the MuPag API?

Yes. Write a rule that allows only POST /v1/charges and GET /v1/charges, and the agent can issue and check charges but cannot refund, cancel subscriptions, or edit customers. Keep it on an sk_test_ key while you watch the log of every call it makes.

MuPag Public API

AI ReadinessAI-Aware (B+)69/100

See full scorecard

Official vendor OpenAPI document · agent-readyPaymentsPayment Processingbearer26 EndpointsREST

For Agents

Create PIX and credit card charges, hosted PIX checkout sessions, subscriptions, customers, and refunds for a Brazilian merchant on MuPag, and simulate payment outcomes in the sandbox.

Use for: Create a PIX charge of 150 reais for a customer, Open a checkout link for two products, Refund half of yesterday's credit card charge, List all pending PIX charges from this week

Not supported: Does not issue boletos, handle payouts to bank accounts, or file taxes. Use for PIX and credit card charges, hosted checkout, subscriptions, and refunds for a MuPag merchant only.

The MuPag Public API lets Brazilian merchants charge customers by PIX or credit card, open hosted PIX checkout sessions, and run subscriptions on a plan with optional trial days and coupons. Charges carry amount_cents, a customer, optional split rules, and an external reference, and can be listed by status, customer, payment method, and creation date with keyset pagination, cancelled while pending, or refunded in full or in part. Customers are created and updated with name, email, and CPF or CNPJ tax id. Every write takes an Idempotency-Key, and sandbox-only routes simulate a paid or failed charge, advance a subscription's billing cycle, and seed test data.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: ASignals: 4

98%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

42%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: BSignals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

56%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: B+Signals: 4

29%

Description Coverage

Coverage of descriptions across API elements.

88%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

52%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: B-Signals: 1

60%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: D+Signals: 1

49%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the MuPag Public API to your agent

Capabilities

Start building with MuPag Public API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

MuPag Public API

Jentic AI Readiness Score

MuPag Public API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness