Polipay POLi Payments API

Name: POLi Payments API
Brand: POLi Payments API
Availability: InStock

✓ Official Vendor SpecPaymentsBank Transferbasic5 EndpointsREST

For Agents

Initiate and track online bank transfer payments in New Zealand using POLi's direct debit payment network.

Install Jentic One Beta

Connect the POLi Payments API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the POLi 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://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 POLi Payments API.

Initiate payment transactions with customer bank account details and transaction amount

Retrieve real-time payment status including pending, completed, and failed states

Access daily transaction reports for reconciliation and accounting workflows

GET STARTED

Start building with POLi Payments API

Explore with Jentic

View OpenAPI Document

POLi is an online debit payment method for New Zealand and Australia that enables direct bank account payments without credit cards or intermediary wallets. The POLi Payments API allows merchants to initiate payment transactions, retrieve payment status, access daily transaction reports, and query supported financial institutions. Unlike card payments, POLi provides guaranteed settlement within 2 business days with significantly lower transaction fees. Merchants use it for high-value transactions, subscription billing, and customer segments preferring direct bank payment. The API handles the secure bank login flow, amount authorization, and payment confirmation, returning a success/failure status to the merchant system. It's particularly popular for utility payments, government fees, and e-commerce checkout where transaction fees impact margin.

Use Cases

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

★ E-commerce Checkout Integration

Online retailers integrate POLi as a payment method alongside credit cards and PayPal to serve customers who prefer direct bank payment. At checkout, the merchant calls the API to initiate a transaction with the order amount and a return URL. POLi redirects the customer to their bank's login page, guides them through payment authorization, and returns them to the merchant site with a payment status. The merchant queries the transaction status endpoint to confirm payment before fulfilling the order. This reduces card processing fees from 2-3% to POLi's flat-rate structure, improving margin on high-value purchases.

Initiate POLi transaction with order total and callback URL, receive transaction token, redirect customer to POLi payment page, handle callback on return, query transaction status to confirm payment success.

Subscription and Recurring Billing

SaaS platforms and subscription businesses use POLi for monthly billing where customers authorize recurring bank transfers. The API's transaction initiation supports storing payment agreements that allow merchants to charge customers automatically on billing dates. Unlike card subscriptions that fail due to expired cards, bank account details remain stable. Billing systems integrate the API to initiate charges, monitor settlement status, and handle payment failures with retry logic. This improves payment success rates and reduces involuntary churn from failed payment methods.

On billing date, initiate POLi transaction for subscription amount with customer's stored payment agreement, monitor transaction status, update subscription billing status on successful payment, trigger dunning workflow on failure.

Daily Transaction Reconciliation

Finance teams use the daily transaction report endpoints to reconcile POLi payments with bank deposits and accounting ledgers. The API returns CSV and JSON formatted reports showing all transactions processed in a 24-hour period with payment references, amounts, timestamps, and settlement status. Automated workflows fetch reports each morning, match transactions to orders in the merchant system, and flag discrepancies for investigation. This streamlines month-end close processes and provides audit trails for payment disputes.

Fetch daily transaction report for previous business day, parse transaction records, match payment references to order IDs in database, update accounting system with settled amounts, flag unmatched transactions for review.

Multi-Bank Payment Options Display

Checkout experiences use the financial institutions endpoint to display supported banks dynamically, allowing customers to see if their bank is compatible before starting payment. The API returns bank names, logos, and availability status, which the merchant UI renders as clickable options. This improves conversion by setting customer expectations and preventing abandonment when customers discover their bank isn't supported mid-flow. The endpoint also enables merchants to detect when new banks are added to POLi's network and update checkout UI automatically.

Query POLi for list of supported financial institutions, render bank logos and names on checkout page, enable/disable payment button based on customer's bank selection, refresh bank list weekly to detect new additions.

Key Endpoints

5 endpoints — poli is an online debit payment method for new zealand and australia that enables direct bank account payments without credit cards or intermediary wallets.

METHOD

PATH

DESCRIPTION

POST

/api/v2/Transaction/Initiate

Initiate a new payment transaction

GET

/api/v2/Transaction/GetTransaction

Retrieve details for a specific transaction

GET

/api/v2/Transaction/GetDailyTransactions

Get daily transaction report in JSON format

GET

/api/v2/Transaction/GetDailyTransactionsCSV

Get daily transaction report in CSV format

GET

/api/Entity/GetFinancialInstitutions

List supported financial institutions

POST

/api/v2/Transaction/Initiate

Initiate a new payment transaction

GET

/api/v2/Transaction/GetTransaction

Retrieve details for a specific transaction

GET

/api/v2/Transaction/GetDailyTransactions

Get daily transaction report in JSON format

GET

/api/v2/Transaction/GetDailyTransactionsCSV

Get daily transaction report in CSV format

GET

/api/Entity/GetFinancialInstitutions

List supported financial institutions

Why Jentic?

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

Credential isolation

POLi merchant credentials (username and password) are encrypted in Jentic's vault. Agents execute payment operations without seeing credentials, and all API calls are logged for PCI compliance auditing.

Intent-based discovery

Agents search by intent like 'initiate a bank transfer payment' and Jentic returns the POLi transaction initiation operation with parameter schema, avoiding documentation of bank-specific flows and callback handling.

Time to first call

Direct POLi integration: 2-3 days to implement transaction flow, callback handling, and reconciliation logic. Through Jentic: 1-2 hours—search for operations, initiate transactions with natural language parameters, handle status polling.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe Payment Intents API

Stripe provides global card payment processing with additional payment methods like bank transfers.

Choose Stripe for card payment processing or when you need global payment method coverage beyond New Zealand and Australia.

Complementary

PayPal Checkout API

PayPal provides wallet and card-based payments with buyer protection.

Use POLi alongside PayPal to offer customers choice between direct bank transfer (POLi) and wallet/card payments (PayPal) at checkout.

Alternative

GoCardless API

GoCardless provides direct debit payments with automated recurring billing for UK, EU, and US.

Choose GoCardless for recurring direct debit in regions outside Australia/New Zealand, or when you need strong automated retry logic for failed payments.

FAQs

Specific to using POLi Payments API through Jentic.

What authentication does the POLi Payments API use?

The POLi API uses HTTP Basic Authentication. You receive merchant credentials (username and password) from POLi when you sign up for a merchant account, which you pass in the Authorization header for all API requests.

How long does it take for POLi payments to settle?

POLi payments settle within 2 business days to the merchant's nominated bank account. The API provides real-time payment confirmation so you can fulfill orders immediately, while settlement occurs in the background.

What banks are supported by POLi in New Zealand?

POLi supports major New Zealand banks including ANZ, ASB, BNZ, Westpac, and Kiwibank. Use the GetFinancialInstitutions endpoint to retrieve the current list programmatically, as POLi adds new institutions periodically.

Can I use POLi for recurring subscription payments?

Yes, POLi supports recurring payment agreements where customers authorize automatic bank transfers on scheduled billing dates. You initiate transactions using stored agreement references rather than requiring customer interaction each billing cycle.

How do AI agents use the POLi Payments API through Jentic?

Agents search Jentic for tasks like 'initiate a bank transfer payment' and receive POLi operation schemas. Jentic vaults merchant credentials, handles authentication, and allows agents to initiate transactions, check payment status, and retrieve reconciliation reports with natural language parameters.