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
v2017.2 (deprecated)
v2019.1 (deprecated)
v2020.1 (latest)
Guides
API Reference
Pinch Website
Pinch Portal
Log In
API Reference
Pinch Portal
Log In
v2020.1 (latest)
Home
Guides
API Reference
My Requests
My Requests
Before you start!
Things to know
Authentication
Authentication
post
Health
get
Payers
Create or Update Payer
post
Get Payer
get
List Payers
get
Delete Payer
del
Create Payment Source
post
Delete Payment Source
del
Payments
Create or Update Payment
post
Create Realtime Payment
post
Get Payment
get
List Payments - Scheduled
get
List Payments - Processed
get
List Payments for Payer
get
Delete payment
del
Check Payment Nonce
post
Payment Links
Create Payment Link
post
Get Payment Link
get
Get Payment Links
get
Get Payment Links by Payer
get
Delete Payment Link
del
Merchants
Update Merchant
post
Get Merchant
get
Create Managed Merchant
post
List Managed Merchants
get
Upload Document
post
Plans and Subscriptions
Create or Update Plan
post
Get Plan
get
List Plans
get
Delete Plan
del
Create Subscription
post
List Subscriptions
get
Get Subscription
get
Cancel Subscription
del
Calculate Plan Payments
get
Events
List all events
get
Get Event
get
Transfers
List all transfers
get
Get Transfer
get
List transfer line items
get
Fees
Get Fees
get
Calculate Fees
post
Webhooks
Create or Update Webhook
post
List Webhooks
get
Get Webhook
get
Delete Webhook
del
TokenISation
Tokenise Payment Source
post
Refunds
Create a Refund
post
List Refunds
get
Get Refund
get
Check Refund Nonce
post
Contacts
Get Contact
get
List Contacts
get
Create or Update Contact
post
Delete Contact
del
Merchant Financial Data
Get Current Merchant Financial Data
get
Save Merchant Financial Data
post
Powered by
••••••cfdd
Endpoint
Method
Status
User Agent
