Pinch

Pinch API

Pinch API as documented publicly: 41 operations. Contract generated from the documentation by API Evangelist (2026-10-12); not the provider's own document.

GitHub OpenAPI

Operations 41

POST /calculate-fees Preview Payment Fees Before Charging #
GET /connect/token GET /connect/token #
POST /connect/token POST /connect/token #
GET /fees/calculate How to pass payment processing fees on to your customers using the surcharge feature. #
POST /merchants Create and control Pinch merchant accounts under your own credentials using the Managed Merchants feature. #
POST /merchants/{merchantid} Managed Merchant Onboarding to First Payment #
POST /payers Call POST /payers to create the Payer, and save the returned Payer ID. #
POST /payers/{payerid}/sources Tokenisation with CaptureJs #
POST /payment-links Generate the link #
POST /payments Tokenisation with CaptureJs #
POST /payments/realtime Tokenisation with CaptureJs #
GET /payments/{id} Handle a Dishonoured Direct Debit and Retry #
GET /plans List plans (paged) #
POST /plans Create or update a plan #
DELETE /plans/{planid} Delete a plan #
GET /plans/{planid} Get a plan #
GET /refund/{id} Refunds #
GET /refunds Refunds #
POST /refunds Refunds #
POST /refunds/nonce Refunds #
POST /sources Vault a Payment Source for Future Billing #
GET /subscriptions List subscriptions (paged) #
POST /subscriptions Create a subscription #
GET /subscriptions/payer/{payerid} List subscriptions for a payer #
GET /subscriptions/plan/{planid} List subscriptions for a plan (paged) #
GET /test/fees/calculate GET /test/fees/calculate #
POST /test/merchants/{merchantid} POST /test/merchants/managed #
DELETE /test/payers/{id} DELETE /test/payers/{id} #
DELETE /test/payers/{id}/sources/{sourceid} DELETE /test/payers/{id}/sources/{sourceid} #
GET /test/payments/payer/id GET /test/payments/payer/id #
POST /test/payments/realtime POST /test/payments/realtime #
GET /test/payments/{id} GET /test/payments/{id} #
GET /test/plans/pln_XXXXXXXX/calculated-payments GET /test/plans/pln_XXXXXXXX/calculated-payments #
GET /test/subscriptions/payer/pyr_XXXXXXXX GET /test/subscriptions/payer/pyr_XXXXXXXX #
DELETE /test/subscriptions/sub_XXXXXXXX DELETE /test/subscriptions/sub_XXXXXXXX #
GET /test/{testid} GET /test/payers #
POST /test/{testid} POST /test/calculate-fees #
GET /transfers Transfers in Pinch Payments #
GET /transfers/items/{transferid} Transfers in Pinch Payments #
GET /transfers/{id} Transfers in Pinch Payments #
POST /webhooks Managed Merchant Onboarding to First Payment #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/openapi/_ae-authored/pinch-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-subscriptions-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-calculate-fees-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-refunds-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-merchants-merchantid-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-plans-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/json-schema/pinch-post-refunds-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pinch:pinch-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pinch-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Pinch API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 41 operation(s) read from 30 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Pinch has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 27
    documentation: 14
    pages-with-code: 22
    pages-read: 30
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.getpinch.com.au/reference/tokens.md
  - https://docs.getpinch.com.au/reference/tokenise.md
  - https://docs.getpinch.com.au/reference/save-payer.md
  - https://docs.getpinch.com.au/reference/get-payment.md
  - https://docs.getpinch.com.au/reference/list-payers.md
  - https://docs.getpinch.com.au/reference/delete-payer.md
  - https://docs.getpinch.com.au/reference/save-payment.md
  - https://docs.getpinch.com.au/reference/realtime-payment.md
  - https://docs.getpinch.com.au/reference/delete-payment-source.md
  - https://docs.getpinch.com.au/reference/list-payments-for-payer.md
  - https://docs.getpinch.com.au/reference/list-processed-payments.md
  - https://docs.getpinch.com.au/reference/list-scheduled-payments.md
  - https://docs.getpinch.com.au/docs/application-authentication
  - https://docs.getpinch.com.au/docs/credit-card-payments
  - https://docs.getpinch.com.au/docs/direct-debit-payments
  - https://docs.getpinch.com.au/docs/capturejs-tokenisation
  - https://docs.getpinch.com.au/docs/plans-and-subscriptions
  - https://docs.getpinch.com.au/docs/payment-links
  - https://docs.getpinch.com.au/docs/transfers-in-pinch-payments
  - https://docs.getpinch.com.au/docs/refunds
  - https://docs.getpinch.com.au/docs/metadata
  - https://docs.getpinch.com.au/docs/surcharging-fees-in-pinch
  - https://docs.getpinch.com.au/docs/managed-merchants
  - https://docs.getpinch.com.au/docs/managed-merchants-payments-guide
  - https://docs.getpinch.com.au/docs/xero-invoice-automation
  - https://docs.getpinch.com.au/docs/preview-fees-before-charging
  - https://docs.getpinch.com.au/docs/vault-payment-source
  - https://docs.getpinch.com.au/docs/handle-dishonoured-direct-debit
  - https://docs.getpinch.com.au/docs/full-subscription-lifecycle
  - https://docs.getpinch.com.au/docs/managed-merchant-onboarding
servers:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/openapi/_ae-authored/pinch-openapi-generated.yml