Install Jentic One Beta

Connect the Azupay Payments API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Azupay Payments 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%2Fazupay.com.au%2Fazupay" | 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%2Fazupay.com.au%2Fazupay" | 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 Azupay Payments API.

Create a payment request and resolve a PayID before money moves

Issue a same-rail refund against a previously settled payment request

Check whether a destination BSB and account are reachable on NPP or PayTo

Retrieve the balance of an Azupay client float account on demand

Search payments and payment requests by reference, status, or date range

GET STARTED

Start building with Azupay Payments API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Azupay Payments API for, with concrete tasks.

★ NPP Real-Time Collections

Collect funds from Australian customers in seconds using the New Payments Platform instead of card rails. The Azupay API issues a payment request linked to a PayID or BSB and account, the customer confirms in their banking app, and settlement reaches the merchant float account within seconds. There is no card surcharge, no chargeback exposure, and reconciliation uses a single end-to-end identifier.

Create a payment request for AUD 250.00 with reference INV-2031, poll its status until settled, and store the resulting paymentId against the invoice

PayTo Recurring Authorisations

Set up customer-authorised recurring debits over the PayTo rail as an alternative to direct debit. The API takes a PayTo agreement reference and triggers payments against it, with each debit confirmed in real time and visible to the payer in their bank app. Suitable for subscription billing, instalment plans, and utility-style recurring collections in Australia.

Trigger a PayTo debit for AUD 49.95 against an existing PayTo agreement reference and record the payment status

Refunds and Reconciliation

Reverse a previously settled NPP payment back to the original payer with a single call against the payment request. The /paymentRequest/{paymentRequestId}/refund endpoint issues a like-for-like refund on the same rail, and the search endpoints return paginated payment and payment request history for back-office reconciliation against the merchant ledger.

Refund payment request pr_5821 in full and write the refund identifier back to the order record

Agent-Driven Australian Payments via Jentic

An AI agent orchestrating Australian commerce workflows can resolve a PayID, create an Azupay payment request, and confirm settlement without leaving the conversation. Jentic exposes Azupay operations behind intent search and isolates the API key in the credential vault, so the agent never sees the raw secret. Integration is one search-load-execute cycle instead of a manual PayID-to-payment flow.

Search Jentic for 'collect a NPP payment in Australia', load the Azupay create payment request schema, and execute it for AUD 120.00 to a supplied PayID

Key Endpoints

18 endpoints — jentic publishes the only available openapi specification for azupay payments api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/paymentRequest

Create a payment request

GET

/paymentRequest/{paymentRequestId}

Get a payment request

POST

/paymentRequest/{paymentRequestId}/refund

Refund a payment request

POST

/payment

Make a payment

POST

/payment/search

Search payments

POST

/accountEnquiry

Check BSB reachability for NPP and PayTo

POST

/paymentRequest

Create a payment request

GET

/paymentRequest/{paymentRequestId}

Get a payment request

POST

/paymentRequest/{paymentRequestId}/refund

Refund a payment request

POST

/payment

Make a payment

POST

/payment/search

Search payments

POST

/accountEnquiry

Check BSB reachability for NPP and PayTo

Why Jentic?

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

Setup

Wiring Azupay by hand means passing the secret key in the Authorization header, choosing between the UAT host api-uat.azupay.com.au and the production api.azupay.com.au, and building the payment-request lifecycle and refund flows yourself. Through Jentic you install once, import the Azupay Payments API from the API Directory, store the API key once, and your agent calls it.

Permission scoping

Azupay puts the payment request id in the URL path (/paymentRequest/{paymentRequestId}/...) while the amount, reference, and target travel in the request body, so scoping is by operation. You limit the agent to the operations it needs, such as POST /paymentRequest or POST /accountEnquiry, so a refund or an API key rotation is not available unless you add it.

Credential isolation

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

Intent-based discovery

Agents search Jentic by intent such as 'collect an NPP payment in Australia' or 'check if an account can receive PayTo', and Jentic returns the matching Azupay operation with its input schema so the agent calls the right endpoint without browsing the docs.

FAQs

Specific to using Azupay Payments API through Jentic.

Why is there no official OpenAPI spec for Azupay Payments API?

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

The API uses an API key passed in the Authorization header. Through Jentic, the key is stored encrypted in your Jentic One instance credential vault and injected at execution time, so the raw key never enters the agent's context. Rotate keys with the API key endpoints when access changes.

Can I refund an NPP payment with the Azupay Payments API?

Yes. POST /paymentRequest/{paymentRequestId}/refund issues a same-rail refund against a previously settled payment request, returning a refund identifier you can store against the original order.

How do I check if an Australian bank account can receive a PayTo or NPP payment?

Use POST /accountEnquiry with the BSB and account number. The response indicates NPP and PayTo reachability before you create a payment request, which avoids failed transfers to non-participating institutions.

What are the rate limits for the Azupay Payments API?

The OpenAPI spec does not declare numeric rate limits. Treat the API as production-grade for real-time settlement and contact Azupay support for limit increases if you exceed throughput on a sandbox or production tenant.

How do I trigger an Azupay payment through Jentic?

Run pip install jentic, then search Jentic with the natural-language query 'collect a NPP payment in Australia'. Jentic returns the POST /paymentRequest operation, you load its input schema, then execute with amount, reference, and target PayID or BSB. The API key is resolved from the vault automatically.

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

Yes. Because Jentic One is self-hosted, you set the rules for which operations and credentials your agent may use, and Azupay scopes access by operation. You can allow only the endpoints the workflow needs, such as POST /paymentRequest to collect a payment or POST /accountEnquiry to check reachability, while withholding others. That means a refund via POST /paymentRequest/{paymentRequestId}/refund or an API key rotation stays unavailable to the agent unless you explicitly add it.

Azupay Payments API

AI ReadinessAI-Aware (B)65/100

See full scorecard

Agent-ready OpenAPI document · curated by JenticPaymentsPayment ProcessingapiKey18 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For Agents

Initiate, track, and refund Australian NPP and PayTo bank payments, resolve PayIDs, and check account reachability without touching card rails.

Use for: I need to collect a payment from an Australian customer over NPP, Check whether a BSB and account number can receive a PayTo payment, Retrieve the current balance on my Azupay client account, Search for all payment requests created in the last 24 hours

Not supported: Does not handle card processing, international payments, or merchant onboarding - use for Australian NPP and PayTo bank-rail payments only.

Jentic publishes the only available OpenAPI specification for Azupay Payments API, keeping it validated and agent-ready. Azupay provides Australian real-time account-to-account payments through the New Payments Platform (NPP) and PayTo rails. The API covers payment requests with PayID resolution, immediate payments, refunds, account and BSB reachability checks, balance enquiries, client management, and API key rotation. Settlement happens directly between bank accounts, so there is no card processing or interchange involved.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A+Signals: 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).

75%

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: B-Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

50%

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: DSignals: 4

25%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

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

55%

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: C-Signals: 1

50%

Authentication Strength

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

100

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A+Signals: 1

100%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the Azupay Payments API to your agent

Capabilities

Start building with Azupay Payments API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Azupay Payments API

Jentic AI Readiness Score

Azupay Payments 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