Pinch Payments

Pinch Payments is an Australian, Brisbane-based payment orchestration and payment-facilitator platform that automates invoice collection and receivables for service businesses, bookkeepers, and software platforms across Australia and New Zealand. Marketing itself as "Aussie-Made Payments Infrastructure," Pinch lets merchants accept direct debit (bank account) and card payments (Visa, Mastercard, American Express), build payment plans and subscriptions, tokenise payment sources client-side with its CaptureJS library, and reconcile settlements back into Xero, QuickBooks, and MYOB. Its Glassbox / Managed Merchants offering is a Payfac-as-a-Service seam with KYC, compliance, and sub-merchant onboarding for platforms acting as aggregators or marketplaces. Pinch is genuinely API-first: it ships a fully documented REST API (JSON, OAuth2 client-credentials auth), a ReadMe-hosted developer portal with a live API explorer, per-product OpenAPI 3.1 definitions, a published Postman collection, an official .NET SDK, Zapier/n8n/viaSocket no-code connectors, webhooks for real-time events, and an llms.txt + docs MCP server for AI-assisted integration.

Pinch Payments publishes 10 APIs on the APIs.io network, including Pinch Core API, Pinch Payers API, and 8 more. Tagged areas include Payments, Australia, Payment Gateway, Payment Processing, and Direct Debit.

The Pinch Payments catalog on APIs.io includes 1 event-driven AsyncAPI specification.

Pinch Payments’ developer surface includes authentication, documentation, API reference, getting-started guide, pricing, engineering blog, signup flow, and 30 more developer resources.

🌐 Visit website 📡 Source on GitHub
60.8/100 strong ▬ flat Agent 80/100 agent native Full breakdown ↓
scored 2026-07-27 · rubric v0.5
10 APIs 1 MCP Servers
PaymentsAustraliaPayment GatewayPayment ProcessingDirect DebitCard PaymentsSubscriptionsBillingPayment FacilitatorAccount-to-AccountNew Zealand

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-27 · rubric v0.5
Composite quality — 60.8/100 · strong
Contract Quality 15.4 / 25
Developer Ergonomics 17.0 / 20
Commercial Clarity 8.9 / 20
Operational Transparency 6.8 / 13
Governance 0.0 / 12
Discoverability 10.0 / 10
Agent readiness — 80/100 · agent native
Machine-Readable Contract 18 / 18
Agentic Access Contract 15 / 15
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 9 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 0 / 7
Typed Event Surface 6 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/pinch-payments: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 10

Individual APIs this provider publishes, each with its own machine-readable definition.

Pinch Core API

Core Pinch REST API covering scheduled and realtime payments, plans and subscriptions, refunds, fees, events, and health — 14 paths / 19 operations. Assembled verbatim from Pinc...

Pinch Payments API

Payments product surface — create/update scheduled payments, take realtime card payments, retrieve and list payments, check payment nonces, and delete payments; 7 paths / 8 oper...

Pinch Payers API

Manage payer records and their payment sources (bank account or credit card) plus client-side tokenisation — create/update, retrieve, list, and delete payers and payment sources...

Pinch Payment Links API

Generate hosted payment pages (payment links) and share them via email, SMS, or chat with no frontend work — create, retrieve, list by payer, and delete payment links; 3 paths /...

Pinch Merchants API

Payfac-as-a-Service / Managed Merchants — create sub-merchant accounts under your own credentials, update merchant details, list managed merchants, and upload compliance documen...

Pinch Webhooks API

Configure webhooks to receive real-time notifications about Pinch events (payer created, payment success/failure, bank results, subscription lifecycle) — create/update, list, re...

Pinch Contacts API

Manage contact records for the authenticated merchant — create/update, retrieve a single contact, list contacts (paginated), and delete contacts; 2 paths / 4 operations.

Pinch Transfers API

Reconcile settlements — list all transfers of settled funds to your bank account, retrieve a transfer, and list its line items back to the underlying payments; 3 paths / 3 opera...

Pinch Merchant Financial Data API

Retrieve the current merchant financial data record and create/update merchant financial data used in compliance and onboarding; 2 paths / 2 operations.

Pinch Authentication API

OAuth2 client-credentials token endpoint — POST /connect/token with HTTP Basic (merchant ID + secret key) and scope api1 to obtain a short-lived Bearer JWT used against the Pinc...

Scroll for all 10

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

Pinch API Docs MCP

MCP SERVER

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Pinch Payments Webhooks

ASYNCAPI

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Pinch Payments Authentication

oauth2/http · 2 schemes

SECURITY

Pinch Payments Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Pinch Payments Scopes

1 scope · clientCredentials

1 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Pinch Payments Agentic Access

56 operations · 27 acting

56 operations · 27 acting

AGENTIC

Resources

Get Started 4

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 SignUp
SignUp
 Sandbox
Sandbox

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess
 MCPServer
MCPServer
 LLMsTxt
LLMsTxt
 AgentSkill
AgentSkill

Design & Contract 8

Pagination, idempotency, versioning, errors, and events

Conformance
Conformance
 ErrorCatalog
ErrorCatalog
 Lifecycle
Lifecycle
 Conventions
Conventions
 Idempotency
Idempotency
 Components
Components
 DataModel
DataModel
 Webhooks
Webhooks

Scroll for all 8

Build 6

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 Postman
Postman
 Packages
Packages
 SDKs
SDKs
 ToolCrosswalk
ToolCrosswalk
 DeclineCodes
DeclineCodes

Access & Security 3

Authentication, authorization, and security posture

OAuthScopes
OAuthScopes
 DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 4

Status, limits, changes, and where to get help

StatusPage
StatusPage
 HelpCenter
HelpCenter
 Deprecation
Deprecation
 ChangeLog
ChangeLog

Commercial 3

Pricing, plans, and the legal terms of use

Pricing
Pricing
 TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 2

The organization behind the API

Website
Website
 Blog
Blog

Other 1

Properties that don't map to a standard resource type

Overlay
Overlay

Source (apis.yml)

apis.yml Raw ↑ 
aid: pinch-payments
url: https://raw.githubusercontent.com/api-evangelist/pinch-payments/refs/heads/main/apis.yml
name: Pinch Payments
kind: company
description: 'Pinch Payments is an Australian, Brisbane-based payment orchestration and payment-facilitator platform that
  automates invoice collection and receivables for service businesses, bookkeepers, and software platforms across Australia
  and New Zealand. Marketing itself as "Aussie-Made Payments Infrastructure," Pinch lets merchants accept direct debit (bank
  account) and card payments (Visa, Mastercard, American Express), build payment plans and subscriptions, tokenise payment
  sources client-side with its CaptureJS library, and reconcile settlements back into Xero, QuickBooks, and MYOB. Its Glassbox
  / Managed Merchants offering is a Payfac-as-a-Service seam with KYC, compliance, and sub-merchant onboarding for platforms
  acting as aggregators or marketplaces. Pinch is genuinely API-first: it ships a fully documented REST API (JSON, OAuth2
  client-credentials auth), a ReadMe-hosted developer portal with a live API explorer, per-product OpenAPI 3.1 definitions,
  a published Postman collection, an official .NET SDK, Zapier/n8n/viaSocket no-code connectors, webhooks for real-time events,
  and an llms.txt + docs MCP server for AI-assisted integration.'
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Payments
- Australia
- Payment Gateway
- Payment Processing
- Direct Debit
- Card Payments
- Subscriptions
- Billing
- Payment Facilitator
- Account-to-Account
- New Zealand
created: '2026-07-24'
modified: '2026-07-24'
specificationVersion: '0.19'
apis:
- aid: pinch-payments:pinch-payments-core
  name: Pinch Core API
  description: Core Pinch REST API covering scheduled and realtime payments, plans and subscriptions, refunds, fees, events,
    and health — 14 paths / 19 operations. Assembled verbatim from Pinch's published per-endpoint OpenAPI 3.1 definitions.
  humanURL: https://docs.getpinch.com.au/reference/things-to-know
  baseURL: https://api.getpinch.com.au
  tags:
  - Payments
  - Subscriptions
  - Refunds
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-core.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/pinch-payments-api-core-concepts
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/things-to-know
- aid: pinch-payments:pinch-payments-payments
  name: Pinch Payments API
  description: Payments product surface — create/update scheduled payments, take realtime card payments, retrieve and list
    payments, check payment nonces, and delete payments; 7 paths / 8 operations.
  humanURL: https://docs.getpinch.com.au/reference/save-payment
  baseURL: https://api.getpinch.com.au
  tags:
  - Payments
  - Direct Debit
  - Card Payments
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-payments.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/credit-card-payments
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/realtime-payment
- aid: pinch-payments:pinch-payments-payers
  name: Pinch Payers API
  description: Manage payer records and their payment sources (bank account or credit card) plus client-side tokenisation
    — create/update, retrieve, list, and delete payers and payment sources; 4 paths / 6 operations.
  humanURL: https://docs.getpinch.com.au/reference/save-payer
  baseURL: https://api.getpinch.com.au
  tags:
  - Payers
  - Tokenisation
  - Payment Sources
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-payers.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/pinch-payments-api-core-concepts
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/save-payer
- aid: pinch-payments:pinch-payments-payment-links
  name: Pinch Payment Links API
  description: Generate hosted payment pages (payment links) and share them via email, SMS, or chat with no frontend work
    — create, retrieve, list by payer, and delete payment links; 3 paths / 5 operations.
  humanURL: https://docs.getpinch.com.au/reference/create-payment-link
  baseURL: https://api.getpinch.com.au
  tags:
  - Payment Links
  - Hosted Checkout
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-payment-links.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/payment-links
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/create-payment-link
- aid: pinch-payments:pinch-payments-merchants
  name: Pinch Merchants API
  description: Payfac-as-a-Service / Managed Merchants — create sub-merchant accounts under your own credentials, update merchant
    details, list managed merchants, and upload compliance documents; 3 paths / 4 operations.
  humanURL: https://docs.getpinch.com.au/reference/create-managed-merchant
  baseURL: https://api.getpinch.com.au
  tags:
  - Payment Facilitator
  - Managed Merchants
  - Onboarding
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-merchants.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/managed-merchants
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/create-managed-merchant
- aid: pinch-payments:pinch-payments-webhooks
  name: Pinch Webhooks API
  description: Configure webhooks to receive real-time notifications about Pinch events (payer created, payment success/failure,
    bank results, subscription lifecycle) — create/update, list, retrieve, and delete webhooks; 2 paths / 4 operations.
  humanURL: https://docs.getpinch.com.au/reference/create-or-update-webhook
  baseURL: https://api.getpinch.com.au
  tags:
  - Webhooks
  - Events
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-webhooks.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/webhooks
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/create-or-update-webhook
- aid: pinch-payments:pinch-payments-contacts
  name: Pinch Contacts API
  description: Manage contact records for the authenticated merchant — create/update, retrieve a single contact, list contacts
    (paginated), and delete contacts; 2 paths / 4 operations.
  humanURL: https://docs.getpinch.com.au/reference/save-contact
  baseURL: https://api.getpinch.com.au
  tags:
  - Contacts
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-contacts.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/pinch-payments-api-core-concepts
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/save-contact
- aid: pinch-payments:pinch-payments-transfers
  name: Pinch Transfers API
  description: Reconcile settlements — list all transfers of settled funds to your bank account, retrieve a transfer, and
    list its line items back to the underlying payments; 3 paths / 3 operations.
  humanURL: https://docs.getpinch.com.au/reference/list-all-transfers
  baseURL: https://api.getpinch.com.au
  tags:
  - Transfers
  - Settlement
  - Reconciliation
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-transfers.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/transfers-in-pinch-payments
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/list-all-transfers
- aid: pinch-payments:pinch-payments-merchant-financial-data
  name: Pinch Merchant Financial Data API
  description: Retrieve the current merchant financial data record and create/update merchant financial data used in compliance
    and onboarding; 2 paths / 2 operations.
  humanURL: https://docs.getpinch.com.au/reference/getcurrentmerchantfinancialdata
  baseURL: https://api.getpinch.com.au
  tags:
  - Merchant Financial Data
  - Compliance
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-merchant-financial-data.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/compliance-process
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/getcurrentmerchantfinancialdata
- aid: pinch-payments:pinch-payments-authentication
  name: Pinch Authentication API
  description: OAuth2 client-credentials token endpoint — POST /connect/token with HTTP Basic (merchant ID + secret key) and
    scope api1 to obtain a short-lived Bearer JWT used against the Pinch API; served from auth.getpinch.com.au.
  humanURL: https://docs.getpinch.com.au/reference/tokens
  baseURL: https://auth.getpinch.com.au
  tags:
  - Authentication
  - OAuth2
  properties:
  - type: OpenAPI
    url: openapi/pinch-payments-authentication.yml
  - type: Documentation
    url: https://docs.getpinch.com.au/docs/application-authentication
  - type: APIReference
    url: https://docs.getpinch.com.au/reference/tokens
common:
- type: OAuthScopes
  url: scopes/pinch-payments-scopes.yml
- type: AgenticAccess
  url: agentic-access/pinch-payments-agentic-access.yml
- type: DomainSecurity
  url: security/pinch-payments-domain-security.yml
- type: Authentication
  url: authentication/pinch-payments-authentication.yml
- type: Website
  url: https://getpinch.com.au/
- type: DeveloperPortal
  url: https://docs.getpinch.com.au/
- type: Documentation
  url: https://docs.getpinch.com.au/
- type: APIReference
  url: https://docs.getpinch.com.au/reference/things-to-know
- type: GettingStarted
  url: https://docs.getpinch.com.au/docs/get-started-with-the-pinch-api
- type: GitHubOrganization
  url: https://github.com/PinchPayments
- type: Postman
  url: https://github.com/PinchPayments/postman-pinch-api
- type: StatusPage
  url: https://status.getpinch.com.au/
- type: Pricing
  url: https://getpinch.com.au/pricing
- type: Blog
  url: https://getpinch.com.au/blog
- type: HelpCenter
  url: https://helpdesk.getpinch.com.au/
- type: SignUp
  url: https://app.getpinch.com.au/register
- type: TermsOfService
  url: https://getpinch.com.au/Legal/Terms/
- type: PrivacyPolicy
  url: https://getpinch.com.au/Legal/Privacy/
- type: Packages
  url: packages/pinch-payments-packages.yml
- type: SDKs
  url: packages/pinch-payments-packages.yml
  name: Pinch .NET SDK (NuGet)
- type: MCPServer
  url: mcp/pinch-payments-mcp.yml
  name: Pinch API Docs MCP
- type: ToolCrosswalk
  url: mcp/pinch-payments-tool-crosswalk.yml
- type: LLMsTxt
  url: llms/pinch-payments-llms.txt
- type: Overlay
  url: overlays/pinch-payments-core-overlay.yaml
- type: Conformance
  url: conformance/pinch-payments-conformance.yml
- type: ErrorCatalog
  url: errors/pinch-payments-problem-types.yml
- type: DeclineCodes
  url: errors/pinch-payments-decline-codes.yml
- type: Lifecycle
  url: lifecycle/pinch-payments-lifecycle.yml
- type: Deprecation
  url: https://docs.getpinch.com.au/docs/versioning
- type: Sandbox
  url: sandbox/pinch-payments-sandbox.yml
- type: Conventions
  url: conventions/pinch-payments-conventions.yml
- type: Idempotency
  url: conventions/pinch-payments-conventions.yml
- type: ChangeLog
  url: changelog/pinch-payments-changelog.yml
- type: Components
  url: components/pinch-payments-components.yml
- type: DataModel
  url: data-model/pinch-payments-data-model.yml
- type: Webhooks
  url: asyncapi/pinch-payments-webhooks.yml
- type: AgentSkill
  url: skills/_index.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com