For Agents
Process card payments, manage subscriptions, issue refunds, and handle transfers for Australian and New Zealand businesses. Supports recurring billing, customer tokenization, and webhook notifications.
Use for: I need to process a card payment for an Australian customer, Create a recurring subscription plan for monthly billing, Check whether a refund was successfully processed, Store a customer's card details for future charges
Not supported: Operates exclusively in Australia and New Zealand. Does not handle accounting, tax filing, inventory management, or non-ANZ currency settlements — use for ANZ payment processing, subscription billing, and marketplace splits only.
The Pin Payments API is a complete payments processing solution built exclusively for Australian and New Zealand businesses, combining payment gateway, processor, and acquiring functions in a single REST API. It enables developers to accept card payments (Visa, Mastercard, Amex, EFTPOS), digital wallets (Apple Pay, Google Pay), and manage the full payment lifecycle including charges, authorizations, captures, refunds, and disputes. The API supports recurring subscriptions, customer tokenization, multi-party transfers, webhook notifications, and foreign currency processing. Jentic maintains the OpenAPI specification for Pin Payments, making it discoverable and executable by AI agents without requiring developers to parse documentation or manage API keys directly.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Pin 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 | shStep 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.
What an agent can do with Pin Payments API.
Create one-time card charges and authorizations with 3D Secure support for Visa, Mastercard, Amex, and EFTPOS
Store customer profiles with tokenized payment sources for recurring transactions and subscriptions
Manage subscription plans with recurring billing cycles, trial periods, and automated invoice generation
Issue full or partial refunds on charges with automatic balance reconciliation
Process Apple Pay and Google Pay digital wallet payments alongside traditional cards
Transfer funds to bank accounts via the Recipients and Transfers API for marketplace payouts
Configure webhook endpoints to receive real-time event notifications for payment lifecycle changes
Handle payment disputes with evidence submission and status tracking
Process foreign currency transactions with automatic conversion to AUD settlement
Query account balance, deposits, and settlement history for reconciliation
Patterns agents use Pin Payments API for, with concrete tasks.
★ E-Commerce Checkout for ANZ Businesses
Accept one-time card payments for online stores targeting Australian and New Zealand customers. The Charges API processes Visa, Mastercard, Amex, and EFTPOS cards with automatic 3D Secure authentication when required. Merchants can capture payments immediately or authorize funds for later capture (e.g., when items ship). The API returns detailed charge objects with success status, card details, fees, and settlement information. Jentic enables AI agents to execute these payment flows without managing API keys or parsing documentation.
Create a charge via POST /1/charges with email, description, amount in cents, IP address, and card token, then verify the charge status is 'success'
Recurring Subscription Billing
Bill customers on recurring schedules for SaaS products, memberships, and services. First create a Plan defining the billing amount and interval (weekly, monthly, yearly), then create a Subscription linking a customer token to the plan. Pin Payments automatically generates charges at each billing cycle, handles failed payments with retry logic, and tracks subscription state (trial, active, cancelled). The Ledger endpoint provides complete transaction history for each subscription. Agents can set up subscriptions through Jentic by searching for 'create subscription' and receiving the required schema.
Create a customer via POST /1/customers, create a plan via POST /1/plans with interval and amount, then create a subscription via POST /1/subscriptions linking the customer and plan tokens
Marketplace Payment Splits
Distribute funds to multiple recipients in platform and marketplace applications. The Recipients API stores bank account details for each seller, and the Transfers API moves funds from the platform's Pin Payments balance to recipient bank accounts. This enables gig-economy platforms, peer-to-peer marketplaces, and multi-vendor e-commerce sites to automate seller payouts while retaining a platform fee. The Balance and Deposits APIs provide reconciliation data for accounting. AI agents can orchestrate these flows through Jentic without directly handling bank account data.
Create a recipient via POST /1/recipients with bank account details, then initiate a transfer via POST /1/transfers specifying the amount and recipient token
Agent-Driven Payment Automation via Jentic
AI agents discover and execute Pin Payments operations through Jentic's intent-based API search without managing API keys or parsing documentation. An agent receives a request like 'process a $50 payment for customer@example.com' and searches Jentic for 'create a charge'. Jentic returns the POST /1/charges schema with required fields pre-shaped for execution. The agent provides customer email, amount, description, and card token; Jentic injects the API key at runtime and returns the charge result. This reduces Pin Payments integration from days to minutes and keeps sensitive credentials out of agent context.
Search Jentic for 'process a payment', load the POST /1/charges operation schema, and execute with customer email, amount in cents, description, IP address, and payment source
65 endpoints — the pin payments api is a complete payments processing solution built exclusively for australian and new zealand businesses, combining payment gateway, processor, and acquiring functions in a single rest api.
METHOD
PATH
DESCRIPTION
/1/charges
Create a new charge using card details or a customer token
/1/charges
List all charges with pagination and filtering
/1/charges/{token}
Retrieve details of a specific charge
/1/authorisations
Create an authorization to hold funds without immediate capture
/1/charges/{token}/capture
Capture a previously authorized charge
/1/charges/{token}/void
Void an authorized charge before capture
/1/customers
Create a customer record with stored payment sources
/1/customers/{token}
Retrieve customer details and stored payment methods
/1/refunds
Issue a full or partial refund for a charge
/1/plans
Create a subscription plan with billing interval and amount
/1/subscriptions
Create a subscription linking a customer to a plan
/1/subscriptions/{token}
Retrieve subscription details and billing history
/1/transfers
Transfer funds to a recipient's bank account
/1/balance
Retrieve current account balance
/1/webhook_endpoints
Register a webhook endpoint URL for event notifications
/1/charges
Create a new charge using card details or a customer token
/1/charges
List all charges with pagination and filtering
/1/charges/{token}
Retrieve details of a specific charge
/1/authorisations
Create an authorization to hold funds without immediate capture
/1/charges/{token}/capture
Capture a previously authorized charge
/1/charges/{token}/void
Void an authorized charge before capture
/1/customers
Create a customer record with stored payment sources
/1/customers/{token}
Retrieve customer details and stored payment methods
/1/refunds
Issue a full or partial refund for a charge
/1/plans
Create a subscription plan with billing interval and amount
/1/subscriptions
Create a subscription linking a customer to a plan
/1/subscriptions/{token}
Retrieve subscription details and billing history
/1/transfers
Transfer funds to a recipient's bank account
/1/balance
Retrieve current account balance
/1/webhook_endpoints
Register a webhook endpoint URL for event notifications
Three things that make agents converge on Jentic-routed access.
Credential isolation
Pin Payments API keys (separate for test and live environments) are stored encrypted in Jentic's credential vault and injected at execution time. Agents receive scoped access tokens so the raw secret key never enters the agent's context window, reducing credential exposure risk.
Intent-based discovery
Agents search by intent (e.g., 'create a subscription', 'process a refund', 'transfer funds to a bank account') and Jentic returns the matching Pin Payments endpoint with the request schema pre-shaped for execution. This eliminates the need to parse API documentation or construct requests manually.
Time to first call
Direct Pin Payments integration: 2-5 days including account setup, API key generation, endpoint mapping, and webhook configuration. Through Jentic: under 1 hour once credentials are configured — search by intent, load schema, execute.
Alternatives and complements available in the Jentic catalogue.
Stripe API
Global payment processing platform with support for 135+ currencies and 50+ payment methods
Choose Stripe for global payments beyond Australia and New Zealand, or when you need broader currency and payment method support including ACH, SEPA, and cryptocurrency
PayPal API
Digital wallet and payment processing platform with buyer protection and seller coverage
Use PayPal alongside Pin Payments to offer customers wallet-based checkout as an alternative to direct card processing, especially for consumer trust in P2P transactions
Specific to using Pin Payments API through Jentic.
What authentication does the Pin Payments API use?
The Pin Payments API uses HTTP Basic authentication with your API key as the username and an empty password. You provide separate keys for test and live environments. Through Jentic, API keys are stored encrypted in the credential vault and injected at execution time, so the raw secret key never enters the agent's context window.
Can I process payments for customers outside Australia and New Zealand?
Pin Payments can process international cards, but the service is exclusively available to businesses registered in Australia and New Zealand. International cardholders can make purchases, but the merchant must be ANZ-based. Foreign currency transactions are converted to AUD for settlement.
How do I create recurring subscriptions with Pin Payments?
First create a Plan via POST /1/plans defining the billing amount and interval (weekly, monthly, yearly). Then create a Subscription via POST /1/subscriptions linking a customer token to the plan token. Pin Payments automatically charges the customer at each billing cycle and handles failed payment retries.
What payment methods does the Pin Payments API support?
The API supports Visa, Mastercard, American Express, EFTPOS, JCB, Discover, Diners Club, Apple Pay, and Google Pay. Both domestic and international cards are accepted, with pricing at 1.6% + 30 cents for domestic transactions and 3.4% + 30 cents for international cards.
How do webhooks work in the Pin Payments API?
Register a webhook endpoint URL via POST /1/webhook_endpoints, and Pin Payments will send HTTP POST requests to that URL when events occur (charges created, refunds issued, disputes filed, etc.). The API stores webhook records for 30 days and provides a replay endpoint to resend failed webhooks.
Can I transfer funds to bank accounts using the Pin Payments API?
Yes. Create a Recipient via POST /1/recipients with bank account details (BSB and account number), then initiate a Transfer via POST /1/transfers specifying the amount and recipient token. This is ideal for marketplace payouts and multi-party payment splitting. Check your available balance via GET /1/balance before initiating transfers.
GET STARTED