# Pinch API

**Canonical:** https://apis.io/apis/pinch/pinch-api/  
**Provider:** Pinch — https://apis.io/providers/pinch/  
**Base URL:** https://api.getpinch.com.au  
**Documentation:** https://docs.getpinch.com.au/reference/tokens.md

Pinch API is one of 2 APIs that [Pinch](https://apis.io/providers/pinch/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

## Operations (41)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pinch/refs/heads/main/openapi/_ae-authored/pinch-openapi-generated.yml
- **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

## Other Pinch APIs (1)

- [Pinch API](https://apis.io/apis/pinch/pinch-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pinch/pinch-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pinch/.