Nupaybusiness NuPay for Business Checkout API
★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey, bearer12 EndpointsREST
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.
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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic 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
Register and look up payout recipients by reference ID
Initiate and complete a CIBA back-channel authorization with OTP
Resend an OTP code for a back-channel authorization in flight
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?
Three things that make agents converge on Jentic-routed access.
Credential isolation
NuPay merchant API keys and OAuth2 client secrets are stored encrypted in the Jentic vault. CIBA back-channel flows execute behind a scoped token, so the raw client secret never appears in the agent's context.
Intent-based discovery
Agents search Jentic with intents like 'create a Brazilian checkout payment' or 'run CIBA OTP authorization' and Jentic returns the matching NuPay operation with its schema.
Time to first call
Direct NuPay integration: 1-2 weeks for OAuth2 client setup, CIBA flows, and refund handling. Through Jentic: under a day — search, load, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Global card processor with growing Pix support in Brazil
Choose Stripe when the merchant needs unified global acquiring; choose NuPay when the priority is native Nubank-account and Brazilian Pix flows.
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 at https://app.jentic.com/sign-up.
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.
GET STARTED