# Pinch Payments Developer API Docs Documentation

## Guides
- [Metadata](https://docs.getpinch.com.au/docs/metadata.md)
- [Webhooks](https://docs.getpinch.com.au/docs/webhooks.md)
- [Xero invoice automation guide](https://docs.getpinch.com.au/docs/xero-invoice-automation.md): Leveraging the Pinch API to automate your Xero invoice workflow.
- [Payment Links](https://docs.getpinch.com.au/docs/payment-links.md): This guide describes how to use the Payment Links feature of the Pinch API.
- [Plans and Subscriptions](https://docs.getpinch.com.au/docs/plans-and-subscriptions.md): This guide explains the Plans and Subscriptions feature in the Pinch API and its capabilities.
- [Transfers in Pinch Payments](https://docs.getpinch.com.au/docs/transfers-in-pinch-payments.md)
- [Build on Pinch with AI](https://docs.getpinch.com.au/docs/build-on-pinch-with-ai.md): Use llms.txt and the Pinch API docs MCP server to build with the Pinch API using AI tools.
- [Dishonour Codes](https://docs.getpinch.com.au/docs/dishonour-codes.md): When a payment fails, these code will tell you why
- [API Error Responses](https://docs.getpinch.com.au/docs/errors.md): These are the HTTP error codes you should expect to receive
- [Events](https://docs.getpinch.com.au/docs/events.md): This document outlines all the different event types that occur within the Pinch system and what they are for.
- [Payment Statuses](https://docs.getpinch.com.au/docs/payment-statuses.md)
- [Refund Statuses](https://docs.getpinch.com.au/docs/refund-statuses.md)
- [Get an SDK](https://docs.getpinch.com.au/docs/sdk.md)
- [Get Support](https://docs.getpinch.com.au/docs/support.md): Use the below form to get support from the Pinch team.
- [Surcharging Fees in Pinch](https://docs.getpinch.com.au/docs/surcharging-fees-in-pinch.md)
- [Test and Live Mode](https://docs.getpinch.com.au/docs/test-and-live-mode.md): Get to know your environment
- [API Versions](https://docs.getpinch.com.au/docs/versioning.md)
- [Application Authentication](https://docs.getpinch.com.au/docs/application-authentication.md): How to use Application Authentication with the Pinch API
- [Tokenisation with CaptureJs](https://docs.getpinch.com.au/docs/capturejs-tokenisation.md)
- [Credit Card Payments](https://docs.getpinch.com.au/docs/credit-card-payments.md): A basic workflow for taking Credit Card payments using Pinch
- [Direct Debit Payments](https://docs.getpinch.com.au/docs/direct-debit-payments.md): A basic workflow for taking Direct Debit payments using Pinch
- [Getting started with the Pinch API](https://docs.getpinch.com.au/docs/get-started-with-the-pinch-api.md): The starting point for your Pinch API integration
- [API Core Concepts](https://docs.getpinch.com.au/docs/pinch-payments-api-core-concepts.md): This document introduces the core entities and concepts of the Pinch Payments API. It's designed to give you a mental model of how everything fits together before you dive into the detailed guides and API reference.
- [Low-Touch Integration Guide for SAAS Platforms](https://docs.getpinch.com.au/docs/low-touch-accounting-integration.md)
- [Pinch Payments Compliance Guide](https://docs.getpinch.com.au/docs/compliance-process.md): To ensure secure and compliant payment processing, Pinch Payments requires specific documentation from businesses and individuals integrating with our platform. This guide outlines what you need to provide and why it matters.
- [Managed Merchants Payments Guide](https://docs.getpinch.com.au/docs/managed-merchants-payments-guide.md): This guide outlines the typical process for taking Payments using Managed Merchants.
- [Managed Merchants Guide](https://docs.getpinch.com.au/docs/managed-merchants.md)
- [Getting started with Pinch n8n integration](https://docs.getpinch.com.au/docs/getting-started-with-pinch-n8n.md): This guide will walk you through setting up and using the Pinch Payments nodes in your n8n workflows.
- [Getting started with Pinch viaSocket integration](https://docs.getpinch.com.au/docs/getting-started-with-pinch-viasocket-integration.md)
- [Getting started with Pinch Zapier integration](https://docs.getpinch.com.au/docs/getting-started-with-pinch-zapier-integration.md)
- [Zapier examples using Pinch](https://docs.getpinch.com.au/docs/pinch-in-zapier-examples.md): Example use cases of the Pinch Zapier integration to help get you started.
- [Zapier Actions](https://docs.getpinch.com.au/docs/zapier-actions.md)
- [Zapier Triggers](https://docs.getpinch.com.au/docs/zapier-triggers.md)

## API Reference
- [Health](https://docs.getpinch.com.au/reference/health.md): Endpoint to check the health of an auth token
- [Authentication](https://docs.getpinch.com.au/reference/tokens.md)
- [Things to know](https://docs.getpinch.com.au/reference/things-to-know.md)
- [Get Event](https://docs.getpinch.com.au/reference/get-event.md)
- [List all events](https://docs.getpinch.com.au/reference/list-all-events.md)
- [Calculate Fees](https://docs.getpinch.com.au/reference/calculate-fees.md)
- [Get Fees](https://docs.getpinch.com.au/reference/get-fees.md): Get the current fee schedule for a merchant.
- [Create Managed Merchant](https://docs.getpinch.com.au/reference/create-managed-merchant.md)
- [List Managed Merchants](https://docs.getpinch.com.au/reference/list-managed-merchants.md)
- [Update Merchant](https://docs.getpinch.com.au/reference/update-merchant.md)
- [Upload Document](https://docs.getpinch.com.au/reference/upload-document.md): Upload a document for merchant compliance
- [Create Payment Source](https://docs.getpinch.com.au/reference/create-payment-source.md): Payments sources are currently either a bank account or credit card
- [Delete Payer](https://docs.getpinch.com.au/reference/delete-payer.md)
- [Delete Payment Source](https://docs.getpinch.com.au/reference/delete-payment-source.md)
- [Get Payer](https://docs.getpinch.com.au/reference/get-payer.md)
- [List Payers](https://docs.getpinch.com.au/reference/list-payers.md)
- [Create or Update Payer](https://docs.getpinch.com.au/reference/save-payer.md): Create or update a Payer record to use for creating Payments.
- [Create Payment Link](https://docs.getpinch.com.au/reference/create-payment-link.md)
- [Delete Payment Link](https://docs.getpinch.com.au/reference/delete-payment-link.md)
- [Get Payment Link](https://docs.getpinch.com.au/reference/get-payment-link.md)
- [Get Payment Links by Payer](https://docs.getpinch.com.au/reference/get-payment-links-by-payer.md)
- [Get Payment Links](https://docs.getpinch.com.au/reference/get-payment-links.md)
- [Check Payment Nonce](https://docs.getpinch.com.au/reference/check-payment-nonce.md)
- [Delete payment](https://docs.getpinch.com.au/reference/delete-payment.md): Delete a Payment record.
- [Get Payment](https://docs.getpinch.com.au/reference/get-payment.md): Get a payment details by id.
- [List Payments for Payer](https://docs.getpinch.com.au/reference/list-payments-for-payer.md): Get all payments for a specific Payer.
- [List Payments - Processed](https://docs.getpinch.com.au/reference/list-processed-payments.md): Paged list of Payments that have been processed.
- [List Payments - Scheduled](https://docs.getpinch.com.au/reference/list-scheduled-payments.md): Paged list of all Payments that are currently scheduled.
- [Create Realtime Payment](https://docs.getpinch.com.au/reference/realtime-payment.md): Take credit card payments with a realtime response.
- [Create or Update Payment](https://docs.getpinch.com.au/reference/save-payment.md): Create or Update a Scheduled Payment
- [Calculate Plan Payments](https://docs.getpinch.com.au/reference/calculate-plan-payments.md): Preview the Scheduled Payments for a Plan before creating a subscription.
- [Cancel Subscription](https://docs.getpinch.com.au/reference/cancel-subscription.md)
- [Create Subscription](https://docs.getpinch.com.au/reference/create-subscription.md)
- [Delete Plan](https://docs.getpinch.com.au/reference/delete-plan.md)
- [Get Plan](https://docs.getpinch.com.au/reference/get-plan.md)
- [Get Subscription](https://docs.getpinch.com.au/reference/get-subscription.md)
- [List Plans](https://docs.getpinch.com.au/reference/list-plans.md)
- [List Subscriptions](https://docs.getpinch.com.au/reference/list-subscriptions.md)
- [Create or Update Plan](https://docs.getpinch.com.au/reference/save-plan.md)
- [Check Refund Nonce](https://docs.getpinch.com.au/reference/check-refund-nonce.md): Check if a Nonce has already been added
- [Create a Refund](https://docs.getpinch.com.au/reference/create-a-refund.md)
- [Get Refund](https://docs.getpinch.com.au/reference/get-refund.md)
- [List Refunds](https://docs.getpinch.com.au/reference/list-refunds.md)
- [Tokenise Payment Source](https://docs.getpinch.com.au/reference/tokenise.md): Safely submit credit card or bank account details to our servers in exchange for a token that can be used in future.
- [Get Transfer](https://docs.getpinch.com.au/reference/get-transfer.md)
- [List all transfers](https://docs.getpinch.com.au/reference/list-all-transfers.md)
- [List transfer line items](https://docs.getpinch.com.au/reference/list-transfer-line-items.md)
- [Create or Update Webhook](https://docs.getpinch.com.au/reference/create-or-update-webhook.md)
- [Delete Webhook](https://docs.getpinch.com.au/reference/delete-webhook.md)
- [Get Webhook](https://docs.getpinch.com.au/reference/get-webhook.md)
- [List Webhooks](https://docs.getpinch.com.au/reference/list-webhooks.md)