Install Jentic One Beta

Connect the NuPay for Business Checkout API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the NuPay for Business Checkout 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%2Fnupaybusiness.com.br%2Fnupaybusiness" | 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%2Fnupaybusiness.com.br%2Fnupaybusiness" | 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 NuPay for Business Checkout API.

Create a checkout payment order for a Brazilian merchant

Query the current status of a payment by PSP reference

Cancel a pending payment before it captures

Issue a refund against a captured payment

GET STARTED

Start building with NuPay for Business Checkout API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use NuPay for Business Checkout API for, with concrete tasks.

★ Brazilian Checkout Capture

Brazilian e-commerce sites accept payments through NuPay by creating a payment order via POST /v1/checkouts/payments and polling status via the PSP-reference status endpoint until the transaction captures. Pix and Nubank-account flows sit behind the same surface, so the merchant integrates once and offers multiple local methods.

Call POST /v1/checkouts/payments with the order amount and method, then poll GET /v1/checkouts/payments/{pspReferenceId}/status until captured

Refunds and Cancellations

Operations issue cancellations on pending orders via POST /v1/checkouts/payments/{pspReferenceId}/cancel and refund captured orders via the refunds endpoint. Both flows are scoped to the original PSP reference, preserving the audit trail expected by Brazilian financial regulators.

Call POST /v1/checkouts/payments/{pspReferenceId}/refunds with the refund amount, then GET the refund by ID to confirm settlement

CIBA Back-Channel Authorization

Merchants offering high-trust flows initiate a CIBA back-channel authorization through POST /v1/backchannel/authentication, the payer receives an OTP, and the merchant completes the flow with /v1/backchannel/authentication/complete. This avoids redirect-based browser hops and works well in voice or chat contexts.

Call POST /v1/backchannel/authentication with the payer reference, collect the OTP, and POST /v1/backchannel/authentication/complete with the OTP value

Agent-Driven Brazilian Checkout

An AI agent embedded in a Brazilian commerce assistant creates checkout payments and tracks status on behalf of the user. Through Jentic the agent searches for 'create a NuPay payment', loads the POST /v1/checkouts/payments schema, and executes without learning the bespoke OAuth2 CIBA conventions.

Search Jentic for 'create a NuPay checkout payment', load the schema for POST /v1/checkouts/payments, and execute with the order amount and merchant ID

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for nupay for business checkout api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/checkouts/payments

Create a payment order

GET

/v1/checkouts/payments/{pspReferenceId}/status

Query payment status

POST

/v1/checkouts/payments/{pspReferenceId}/cancel

Cancel a pending payment

POST

/v1/checkouts/payments/{pspReferenceId}/refunds

Request a refund

POST

/v1/recipients

Create a beneficiary

POST

/v1/backchannel/authentication

Initiate CIBA OTP authorization

POST

/v1/backchannel/authentication/complete

Validate OTP code

POST

/v1/token

Exchange code or refresh token

POST

/v1/checkouts/payments

Create a payment order

GET

/v1/checkouts/payments/{pspReferenceId}/status

Query payment status

POST

/v1/checkouts/payments/{pspReferenceId}/cancel

Cancel a pending payment

POST

/v1/checkouts/payments/{pspReferenceId}/refunds

Request a refund

POST

/v1/recipients

Create a beneficiary

POST

/v1/backchannel/authentication

Initiate CIBA OTP authorization

POST

/v1/backchannel/authentication/complete

Validate OTP code

POST

/v1/token

Exchange code or refresh token

Why Jentic?

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

Setup

Wiring NuPay for Business by hand means juggling two auth schemes, the X-Merchant-Key header and an OAuth2 JWT bearer token, running the CIBA back-channel flow, and choosing the sandbox or production host yourself. Through Jentic you install once, import NuPay from the API Directory, store the merchant key and client secret once, and your agent calls it.

Permission scoping

NuPay puts the payment id in the URL path (/v1/checkouts/payments/{pspReferenceId}/...), so a rule can pin your agent to the operations it needs against those payments: it can create payments and check status while a destructive operation like cancel or refund is not included unless you add it. You choose the operations it may call.

Credential isolation

Your NuPay merchant key and OAuth2 client secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a Brazilian checkout payment' or 'run CIBA authorization', and Jentic returns the matching NuPay operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using NuPay for Business Checkout API through Jentic.

Why is there no official OpenAPI spec for NuPay for Business Checkout API?

NuPay for Business does not publish an OpenAPI specification on its public docs site. Jentic generates and maintains this spec so that AI agents and developers can call NuPay for Business Checkout API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the NuPay for Business Checkout API use?

The spec declares two schemes: an apiKey scheme for merchant identification and a bearer token scheme for OAuth2-issued access tokens. Through Jentic both are stored encrypted in the vault and injected at execution, so the raw secrets never enter the agent's context.

Can I cancel a payment that has not yet captured?

Yes. Call POST /v1/checkouts/payments/{pspReferenceId}/cancel with the PSP reference returned at creation. The endpoint only succeeds while the payment is still pending - once captured, use the refund flow instead.

How do I run a CIBA back-channel authorization through Jentic?

Search Jentic for 'CIBA back-channel authentication', load the schema for POST /v1/backchannel/authentication, then collect the OTP and call POST /v1/backchannel/authentication/complete. Jentic handles credential injection on both calls.

What are the rate limits for the NuPay for Business Checkout API?

Rate limits are not declared in the OpenAPI spec. NuPay applies merchant-tier limits in production; check your NuPay merchant dashboard or contact your account manager for the exact quotas attached to your client.

How do I refund a captured payment?

Call POST /v1/checkouts/payments/{pspReferenceId}/refunds with the refund amount, then GET /v1/checkouts/payments/{pspReferenceId}/refunds/{refundId} to confirm the refund settled. Both calls require the original PSP reference.

Can I limit what my agent is allowed to do with the NuPay for Business Checkout API?

Yes. Jentic One is self-hosted, so your own rules decide which NuPay operations and credentials the agent may use. Because NuPay carries the payment id in the URL path, you can pin the agent to just the operations it needs, letting it create payments and check status while cancel and refund stay out of reach unless you add them. Your merchant key and OAuth2 client secret are stored encrypted by your instance and injected at execution, never entering the agent's context.

Nupaybusiness NuPay for Business Checkout API

Name: NuPay for Business Checkout API
Brand: NuPay for Business Checkout API
Availability: InStock

Agent-ready OpenAPI document · curated by JenticPaymentsPayment ProcessingapiKey, bearer12 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For Agents

Capture and refund checkout payments, manage payout recipients, and run OAuth2 CIBA flows for the NuPay for Business gateway.

Use for: Create a NuPay checkout payment order, Get the status of a NuPay payment by PSP reference, Cancel a pending NuPay payment, Refund a captured NuPay payment

Not supported: Does not handle accounting, KYC onboarding, or merchant settlement reporting - use for NuPay checkout payments, refunds, recipients, and OAuth2 authorization only.

Jentic publishes the only available OpenAPI specification for NuPay for Business Checkout API, keeping it validated and agent-ready. NuPay for Business is Nubank's checkout product for Brazilian merchants, providing payment capture, refunds, recipient management, and OAuth2 authorization with CIBA-OTP support. The API exposes a checkout payments suite, a recipient registry, and a full set of OAuth2 endpoints including back-channel authentication for low-friction payer authorization. It is used by Brazilian e-commerce, marketplaces, and SaaS billing flows that want native Pix and Nubank-account checkout.

Jentic One on Github View OpenAPI Document

Connect the NuPay for Business Checkout API to your agent

Capabilities

Start building with NuPay for Business Checkout API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Nupaybusiness NuPay for Business Checkout API