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-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Pinch Payments 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:
- url: https://api.getpinch.com.au
security:
- apiKey: []
tags:
- name: Payments
paths:
  /payments:
    post:
      operationId: post_payments
      tags:
      - Payments
      summary: Tokenisation with CaptureJs
      x-source: https://docs.getpinch.com.au/docs/capturejs-tokenisation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPaymentsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /payments/realtime:
    post:
      operationId: post_payments_realtime
      tags:
      - Payments
      summary: Tokenisation with CaptureJs
      x-source: https://docs.getpinch.com.au/docs/capturejs-tokenisation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPaymentsRealtimeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /payments/{id}:
    get:
      operationId: get_payments_id
      tags:
      - Payments
      summary: Handle a Dishonoured Direct Debit and Retry
      x-source: https://docs.getpinch.com.au/docs/handle-dishonoured-direct-debit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostPaymentsRequest:
      type: object
      properties:
        token:
          type: string
          description: Short‑lived token returned by CaptureJS
      required:
      - token
    PostPaymentsRealtimeRequest:
      type: object
      properties:
        token:
          type: string
          description: Short‑lived token returned by CaptureJS
      required:
      - token
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization