Integration

Pinch Payments integration

Pinch Payments is an Australian payment platform for direct debit and card payments. With this API an agent can create, update, read and delete payers and attach or remove their payment sources (from a CaptureJS token or bank details); schedule payments or charge a payer immediately (realtime), list scheduled and processed payments, refund them and check nonces to avoid double charges; create plans and subscribe payers to them; create, list and delete hosted payment links; read the fee schedule and preview fees; poll events; read settlement transfers and their line items; and manage webhooks. Amounts are in cents. Left out: card tokenisation (raw card numbers stay in CaptureJS), managed-merchant onboarding, merchant updates, compliance documents, compliance contacts and merchant financial data; bank account numbers, stored source tokens, agreement view tokens and webhook signing secrets are stripped from answers. Authentication is OAuth 2.0 client credentials with an Application ID and Secret Key from the Pinch portal (API Keys); the same keys work in test and live, chosen by the connection's environment.

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in Pinch Payments.Built from the 41 Pinch Payments tools below, on the connection you add once.

What you can do with Pinch Payments

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Payment link, 5 operations

  • create_payment_linkCreate payment linkPOSTCreates a hosted payment page for one payment by a payer and returns its url to share by email, SMS or chat. Nothing is charged until the payer pays on the page.
  • delete_payment_linkDelete payment linkDELETEDeletes a payment link so the payer can no longer pay through it.
  • get_payment_linkGet payment linkGETReturns one payment link: amount in cents, currency, hosted page url, payer, description, expiry, allowed and surcharged methods, return url and metadata.
  • list_payment_linksList payment linksGETLists payment links: amount, currency, hosted page url, payer, description, expiry, allowed and surcharged methods and return url; paged.
  • list_payment_links_by_payerList payment links by payerGETLists the payment links created for one payer, paged.

Payer, 4 operations

  • delete_payerDelete payerDELETEPermanently deletes a payer.
  • get_payerGet payerGETReturns one payer (personal data): contact details, company, metadata, direct debit agreements and stored payment sources (card last 4 digits, scheme and expiry; bank BSB and name).
  • list_payersList payersGETLists payers (personal data: names, emails, mobile numbers), optionally searched by name or email, paged (pageSize at most 500).
  • save_payerSave payerPOSTCreates a payer (someone you collect money from) or, when id is given, updates that payer; returns it. A payment source can be attached in the same call with a CaptureJS token.

Plan, 4 operations

  • create_planCreate planPOSTCreates a payment plan: fixed and/or recurring payments by amount in cents or by percentage of a subscription total. Subscribe payers to it with create_subscription.
  • delete_planDelete planDELETEDeletes a plan and cancels every subscription on it, which deletes their payments not yet taken. Payments already in progress complete.
  • get_planGet planGETReturns one plan: name, fixed payments, recurring payment rules (amount or percentage, frequency, start and end conditions), subscriber count and metadata.
  • list_plansList plansGETLists payment plans (name, fixed and recurring payments, subscriber count), paged.

Subscription, 4 operations

  • cancel_subscriptionCancel subscriptionDELETECancels a subscription: its scheduled payments are deleted; payments already processing complete as normal.
  • create_subscriptionCreate subscriptionPOSTMoves money over time: subscribes a payer to a plan, which generates the plan's scheduled payments from the start date. Returns the subscription with its payments.
  • get_subscriptionGet subscriptionGETReturns one subscription: payer, plan, status (active, cancelled, failed, complete), start date, fixed and recurring payments, total amount, metadata and surcharge.
  • list_subscriptionsList subscriptionsGETLists subscriptions (a payer on a plan): payer, plan, status (active, cancelled, failed, complete), start date and payment schedule; paged.

Webhook, 4 operations

  • delete_webhookDelete webhookDELETEDeletes a webhook so Pinch stops posting events to its URI.
  • get_webhookGet webhookGETReturns one webhook: id and the URI Pinch posts events to. The signing secret is not returned.
  • list_webhooksList webhooksGETLists the webhooks: id and the URI Pinch posts events to. Signing secrets are not returned.
  • save_webhookSave webhookPOSTCreates a webhook (or updates it when id is given) that makes Pinch POST events to a URI. Pinch then sends data to that address. The signing secret is not returned.

Payment, 3 operations

  • delete_paymentDelete paymentDELETEDeletes a payment record, cancelling a scheduled payment.
  • get_paymentGet paymentGETReturns one payment: amount in cents, status, transaction and transfer dates, fees, payer, subscription, metadata and every attempt (with dishonour code when it failed).
  • list_payments_for_payerList payments for payerGETLists every payment of one payer, with status, amounts, fees, attempts and transfer dates.

Event, 2 operations

  • get_eventGet eventGETReturns one event: type, date, a summary (metadata) and its data: the payment, bank-result dishonours, payer, subscription, processed payments, refund or transfer it is about.
  • list_eventsList eventsGETLists Pinch events (payments, bank results, transfers, refunds, payers, subscriptions) with type, date and summary, filtered by date range and type, paged (pageSize at most 500). Read data with get_event.

Payment source, 2 operations

  • add_payment_sourceAdd payment sourcePOSTAttaches a payment source to a payer: a bank account (BSB, number and name) or a card or bank account tokenised by Pinch CaptureJS. Returns the source (src_...).
  • delete_payment_sourceDelete payment sourceDELETEPermanently removes a payment source from a payer.

Refund, 2 operations

  • create_refundCreate refundPOSTMoves money: refunds all or part of a payment to the payer, debited from the merchant's bank account. Only within 180 days of the payment.
  • list_refundsList refundsGETLists refunds, optionally within a date range, paged (pageSize at most 500): amount, status, dates, reason and the payment refunded.

Transfer, 2 operations

  • get_transferGet transferGETReturns one transfer: date, amount, fees, tax, account name, reference, status, type and a summary by category (count, gross, fees, total).
  • list_transfersList transfersGETLists settlement transfers of collected funds to the merchant's bank account: date, amount, currency, account name, reference, status and type; paged.

Fee, 1 operation

  • calculate_feesCalculate feesPOSTRead-only: previews the fees and net amount for a payment of a given amount (in cents) on a source, token or source type, including any surcharge. Charges nothing.

Fee schedule, 1 operation

  • get_fee_scheduleGet fee scheduleGETReturns the merchant's current fee schedule: one line per scheme and zone with percentage and fixed fee, cap, dishonour, dispute and refund fees, and tax rate.

Payment nonce, 1 operation

  • check_payment_nonceCheck payment noncePOSTRead-only: checks whether a payment nonce was already used; if so returns that payment (isNonceReplay true). Use it after a timeout before retrying a charge.

Processed, 1 operation

  • list_processed_paymentsList processed paymentsGETLists processed payments (any status after scheduling), optionally by transaction date range or a payment or attempt id, paged (pageSize at most 500).

Realtime payment, 1 operation

  • create_realtime_paymentCreate realtime paymentPOSTCharges money now: takes a payment immediately from a payer's card or source (or a CaptureJS token) and returns the result. A failed charge carries a dishonour code.

Refund nonce, 1 operation

  • check_refund_nonceCheck refund noncePOSTRead-only: checks whether a refund nonce was already used; if so returns that refund (isNonceReplay true). Use it after a timeout before retrying a refund.

Scheduled, 1 operation

  • list_scheduled_paymentsList scheduled paymentsGETLists the payments currently scheduled (not yet processed), with payer, amount, date and status; paged (pageSize at most 500).

Scheduled payment, 1 operation

  • save_scheduled_paymentSave scheduled paymentPOSTMoves money: schedules a payment from a payer on transactionDate (or updates it when id is given), taken from the payer's source. Returns the payment with its status.

Transfer line item, 1 operation

  • list_transfer_line_itemsList transfer line itemsGETLists the line items of one transfer (settled payments, dishonours, refunds and fees) to reconcile it, paged.

Use Pinch Payments from Claude Code, Cursor or Codex

Connect Pinch Payments in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Pinch Payments operations become tools the client can call, next to every other integration you connected.

Claude Code
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"
Codex (~/.codex/config.toml)
[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"
Cursor, Claude Desktop and other JSON configs
{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect Pinch Payments

  1. Create your workspace

    Sign up free. Nothing to install.

  2. Connect Pinch Payments once

    Add your Pinch Payments connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.

  3. Describe the job in chat

    The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.

Pinch Payments integration FAQ

What can you do with the Pinch Payments integration?

LiveContext exposes 41 operations on Pinch Payments, covering payment link, payer, plan and subscription.

Popular integrations

Browse the whole catalog