Nuapay TPP API Specification

Name: Nuapay TPP API Specification API
Brand: Nuapay TPP API Specification
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey, oauth212 EndpointsREST

For Agents

Initiate PSD2 open-banking payments and refunds, browse supported banks, and query payment status across the Nuapay TPP network.

Install Jentic One Beta

Connect the Nuapay TPP API Specification to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Nuapay TPP API Specification, 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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

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 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 Nuapay TPP API Specification API.

Initiate a Pay-by-Bank payment from a payer's bank account

Retrieve a payment record and its current open-banking status

List all payments created by a merchant or partner

GET STARTED

Start building with Nuapay TPP API Specification API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Nuapay TPP API Specification, keeping it validated and agent-ready. Nuapay is a regulated PSD2 third-party provider that initiates open-banking payments directly from a payer's bank account across the UK and EU. The TPP API exposes payment initiation, refund, payment history, and bank discovery endpoints for merchants and partner integrators that want to bypass card rails. It is used by SaaS billing, e-commerce checkouts, and B2B collections where Pay-by-Bank is preferred over card networks.

Use Cases

Patterns agents use Nuapay TPP API Specification API for, with concrete tasks.

★ Pay-by-Bank Checkout

Merchants offer Pay-by-Bank as a checkout option to avoid card processing fees. The flow starts with POST /payments, the customer authenticates at their bank, and the merchant polls GET /payments/{paymentId} until the open-banking status confirms settlement. Nuapay handles the regulated AISP and PISP flows in the background.

Call POST /payments with the order amount and payer bank, then poll GET /payments/{paymentId} until the status reaches settled

Bank Selection and Discovery

Checkout pages render a bank picker driven by GET /bankfamilies and GET /banks so the payer can choose their institution before authorisation. The endpoints return logos, identifiers, and payment-rail support that the front end uses to filter selectable banks.

Call GET /bankfamilies, then GET /banks to populate a bank picker for an open-banking checkout

Refunds and Payment History

Operations teams reconcile open-banking flows by calling GET /payments/{paymentId}/history for the full event timeline and POST /payments/{paymentId}/refunds to push money back to the payer. Refunds and history are scoped to a specific payment ID to preserve audit trails.

Call POST /payments/{paymentId}/refunds with the refund amount, then GET /payments/{paymentId}/refunds/{refundId} to confirm status

Agent-Driven Open-Banking Workflow

An AI agent initiates Pay-by-Bank checkouts on behalf of a finance team, polls payment status, and triggers refunds when an order is cancelled. Through Jentic the agent searches for 'initiate open banking payment', loads the POST /payments schema, and executes without learning Nuapay's TPP-specific OAuth flow.

Search Jentic for 'initiate open banking payment', load the schema for POST /payments, and execute with the merchant ID and amount

Key Endpoints

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

METHOD

PATH

DESCRIPTION

POST

/payments

Create an open-banking payment

GET

/payments/{paymentId}

Retrieve a payment by ID

PATCH

/payments/{paymentId}

Retry a payment

GET

/payments/{paymentId}/history

Retrieve payment event history

POST

/payments/{paymentId}/refunds

Refund a payment

GET

/bankfamilies

List bank families

GET

/banks

List supported banks

POST

/payments

Create an open-banking payment

GET

/payments/{paymentId}

Retrieve a payment by ID

PATCH

/payments/{paymentId}

Retry a payment

GET

/payments/{paymentId}/history

Retrieve payment event history

POST

/payments/{paymentId}/refunds

Refund a payment

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Nuapay merchant and partner credentials, including API keys and OAuth2 client secrets, are stored encrypted in the Jentic vault. Agents receive scoped access tokens, so the underlying TPP credentials never enter the agent's context.

Intent-based discovery

Agents search Jentic with intents like 'initiate open banking payment' or 'refund pay by bank' and Jentic returns the matching Nuapay operation with its input schema.

Time to first call

Direct Nuapay integration: 5-10 days for OAuth2 client setup, bank discovery, and refund handling. Through Jentic: under an hour — search, load, execute.

FAQs

Specific to using Nuapay TPP API Specification API through Jentic.

Why is there no official OpenAPI spec for Nuapay TPP API Specification?

Nuapay does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Nuapay TPP API Specification 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 Nuapay TPP API use?

The spec defines four schemes: MerchantApiKey and PartnerApiKey for HTTP key auth, plus MerchantOAuth2 and PartnerOAuth2 client-credentials flows. Through Jentic the appropriate credential is stored in the vault and injected at execution, so the agent never holds the raw key or token.

Can I retry a payment that failed at the bank?

Yes. PATCH /payments/{paymentId} retries a payment whose initiation expired or failed before the payer authenticated. Use this rather than creating a brand-new payment so the audit trail remains continuous.

How do I refund an open-banking payment through Jentic?

Search Jentic for 'refund open banking payment', load the schema for POST /payments/{paymentId}/refunds, and execute with the refund amount. Jentic injects the merchant credential and returns the created refund record.

What are the rate limits for the Nuapay TPP API?

The OpenAPI spec does not declare explicit rate limits. Nuapay applies regulated TPP limits and merchant-tier quotas in production; check your Nuapay dashboard or contact your account manager for the limits attached to your client ID.

How do I show a bank picker on my checkout?

Call GET /bankfamilies to list grouped institutions, then GET /banks to render individual selectable banks with logos and identifiers. Filter by country and the payment rails the bank supports before showing the picker.

Nuapay TPP API Specification

Connect the Nuapay TPP API Specification to your agent

Capabilities

Start building with Nuapay TPP API Specification API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs