For AI agents: visit https://docs.getpinch.com.au/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference Pinch Website

Home Guides API Reference

Guides API Reference Pinch Website Pinch Portal Log In

Guides

Pinch Portal Log In

Home Guides API Reference

Getting Started

Getting started with the Pinch API
API Core Concepts
Application Authentication
Credit Card Payments
Direct Debit Payments
Tokenisation with CaptureJs
Test and Live Mode
API Versions

Core Features

Plans and Subscriptions
Payment Links
Transfers in Pinch Payments
Refunds
Metadata
Webhooks
Surcharging Fees in Pinch

Managed Merchants

Managed Merchants Guide
Pinch Payments Compliance Guide
Managed Merchants Payments Guide

Integrations

Getting started with Pinch Zapier integration
Zapier Triggers
Zapier Actions
Zapier examples using Pinch
Getting started with Pinch n8n integration
Getting started with Pinch viaSocket integration
Xero invoice automation guide
Low-Touch Integration Guide for SAAS Platforms

Recipes

Preview Payment Fees Before Charging
Vault a Payment Source for Future Billing
Handle a Dishonoured Direct Debit and Retry
Full Subscription Lifecycle with Failure Recovery
Managed Merchant Onboarding to First Payment
Transfer Reconciliation
Idempotent Payment Submission with Nonce

Resources

Get an SDK
Build on Pinch with AI
Get Support

Reference

Payment Statuses
Refund Statuses
API Error Responses
Dishonour Codes
Events

Powered by

Get Support

Get in touch with the Pinch team for integration help or technical support.

Updated 3 months ago

What’s Next

Getting started with the Pinch API

Did this page help you?