# Pinch Payments API Documentation

This is the complete API documentation for connecting to the Pinch Payments API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Pinch Payments connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/pinchPayments/actions/{actionSlug}/run
```

## Pinch Payments actions

- POST `create-or-update-payer` Create or Update Payer
- POST `create-or-update-payment` Create or Update Payment
- POST `create-payment-link` Create Payment Link
- POST `create-payment-source` Create Payment Source
- POST `create-realtime-payment` Create Realtime Payment
- POST `create-refund` Create Refund
- DELETE `delete-payer` Delete Payer
- DELETE `delete-payment` Delete Payment
- DELETE `delete-payment-link` Delete Payment Link
- DELETE `delete-payment-source` Delete Payment Source
- GET `get-event` Get Event
- GET `get-merchant` Get Merchant
- GET `get-payer` Get Payer
- GET `get-payment` Get Payment
- GET `get-payment-link` Get Payment Link
- GET `get-refund` Get Refund
- GET `list-events` List Events
- GET `list-payers` List Payers
- GET `list-payment-links` List Payment Links
- GET `list-payment-links-for-payer` List Payment Links for Payer
- GET `list-payments-for-payer` List Payments for Payer
- GET `list-processed-payments` List Processed Payments
- GET `list-refunds` List Refunds
- GET `list-scheduled-payments` List Scheduled Payments