Pinch Payments API Documentation

This is the complete API documentation for connecting to the Pinch Payments API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Pinch Payments: Manage merchants, payers, payments, payment links, refunds, events, and related payment operations in Pinch Payments. Keep reading to get started.

Quickstart

Before you run your first Pinch Payments request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Pinch Payments connection — create or choose one in Connections. Note its connectionId.

Every Pinch Payments action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/pinchPayments/latest/actions/{actionSlug}

You need a MindCloud API Key and a Pinch Payments connection. Then call an action such as Get Event:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/pinchPayments/latest/actions/get-event" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Pinch Payments account that should run the action. MindCloud stores and refreshes the Pinch Payments credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Pinch Payments actions

All 24 published actions for this Pinch Payments version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate or Update Payer
• POSTCreate or Update Payment
• POSTCreate Payment Link
• POSTCreate Payment Source
• POSTCreate Realtime Payment
• POSTCreate Refund
• DELETEDelete Payer
• DELETEDelete Payment
• DELETEDelete Payment Link
• DELETEDelete Payment Source
• GETGet Event
• GETGet Merchant
• GETGet Payer
• GETGet Payment
• GETGet Payment Link
• GETGet Refund
• GETList Events
• GETList Payers
• GETList Payment Links
• GETList Payment Links for Payer
• GETList Payments for Payer
• GETList Processed Payments
• GETList Refunds
• GETList Scheduled Payments

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad