Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Pinch Payments

Australian payment processing platform for direct debits, credit cards, and recurring payments. Create payers, process payments, manage subscriptions, and handle payment sources with comprehensive webhook support.

CategoryPayment Processing
Authenticationcustom
Version0.0.10
Published scopes0 published scopes
Last updatedSeptember 30, 2026

Overview

Connect Pinch Payments with Flows360

Australian payment processing platform for direct debits, credit cards, and recurring payments. Create payers, process payments, manage subscriptions, and handle payment sources with comprehensive webhook support.

Use the Pinch Payments connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 8 actions and 14 triggers.

Available actions

  • Create or Update Payer
  • Create Realtime Payment
  • Add Source to Payer
  • Create or Update Scheduled Payment
  • Add Subscription
  • Find Event
  • Find Payer
  • Find Subscription

Available triggers

  • Bank Results Event
  • Payer Created
  • Payer Updated
  • Realtime Payment
  • Payment Created
  • Subscription Created
  • Plus 8 additional declared triggers.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Pinch Payments
  • Package: @activepieces/piece-pinch-payments@0.0.10
  • Exact artifact digest: sha256:ada9478aece8e59df73f5625c0620490810ad11e8e43bc62348bb1ff12cc436d
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Create or Update Payer (create_or_update_payer), Create a new payer or update an existing one Classification: read.
  • Create Realtime Payment (create_realtime_payment), Create a real-time payment against a credit card or bank account Classification: read.
  • Add Source to Payer (add_source_to_payer), Add a payment source (bank account or credit card) to an existing payer Classification: read.
  • Create or Update Scheduled Payment (create_or_update_scheduled_payment), Create a new scheduled payment or update an existing one Classification: read.
  • Add Subscription (add_subscription), Create a subscription between a payer and a plan Classification: read.
  • Find Event (find_event), Find an event using the Event ID Classification: read.
  • Find Payer (find_payer), Find a payer by their Payer ID Classification: read.
  • Find Subscription (find_subscription), Find a subscription using the Subscription ID Classification: read.

Trigger contracts

  • Bank Results Event, webhook.
  • Payer Created, webhook.
  • Payer Updated, webhook.
  • Realtime Payment, webhook.
  • Payment Created, webhook.
  • Subscription Created, webhook.
  • Subscription Cancelled, webhook.
  • Subscription Complete, webhook.
  • Refund Created, webhook.
  • Refund Updated, webhook.
  • Scheduled Process, webhook.
  • Transfer Created, webhook.
  • Dispute Created, webhook.
  • Dispute Updated, webhook.

Verification

Runtime execution evidence is managed separately from package metadata.

Capability summary

Authenticationcustom
Supported objects22
Supported actions8
Triggers14

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Application ID Required
  • Secret Key Required · protected credential
  • Environment Required

Supported objects

ObjectReadWriteNotes
Create or Update Payer Yes No Create a new payer or update an existing one
Create Realtime Payment Yes No Create a real-time payment against a credit card or bank account
Add Source to Payer Yes No Add a payment source (bank account or credit card) to an existing payer
Create or Update Scheduled Payment Yes No Create a new scheduled payment or update an existing one
Add Subscription Yes No Create a subscription between a payer and a plan
Find Event Yes No Find an event using the Event ID
Find Payer Yes No Find a payer by their Payer ID
Find Subscription Yes No Find a subscription using the Subscription ID
Bank Results Event Yes No webhook trigger declared by the pinned package.
Payer Created Yes No webhook trigger declared by the pinned package.
Payer Updated Yes No webhook trigger declared by the pinned package.
Realtime Payment Yes No webhook trigger declared by the pinned package.
Payment Created Yes No webhook trigger declared by the pinned package.
Subscription Created Yes No webhook trigger declared by the pinned package.
Subscription Cancelled Yes No webhook trigger declared by the pinned package.
Subscription Complete Yes No webhook trigger declared by the pinned package.
Refund Created Yes No webhook trigger declared by the pinned package.
Refund Updated Yes No webhook trigger declared by the pinned package.
Scheduled Process Yes No webhook trigger declared by the pinned package.
Transfer Created Yes No webhook trigger declared by the pinned package.
Dispute Created Yes No webhook trigger declared by the pinned package.
Dispute Updated Yes No webhook trigger declared by the pinned package.

Supported actions

Create or Update Payer · Read

Create a new payer or update an existing one

create_or_update_payer · Risk: low · Retry: safe

Inputs

  • payerId · string · Optional, Select an existing payer to update, or leave empty to create a new one
  • firstName · string · Required, First name of the payer
  • lastName · string · Optional, Last name of the payer
  • emailAddress · string · Required, Email address of the payer
  • mobileNumber · string · Optional, Mobile phone number
  • companyName · string · Optional, Company name
  • companyRegistrationNumber · string · Optional, Company registration number (ABN, etc.)
  • streetAddress · string · Optional, Street address
  • suburb · string · Optional, Suburb or city
  • state · string · Optional, State or territory
  • postcode · string · Optional, Postal code
  • country · string · Optional, Country
  • metadata · string · Optional, Custom metadata for the payer
  • addPaymentSource · boolean · Optional, Add a payment source (bank account or credit card) to this payer
  • sourceType · string · Optional, Type of payment source
  • sourceToken · string · Optional, The token created by the Pinch capture script
  • ipAddress · string · Optional, IP address of the payer (for payment source)
Create Realtime Payment · Read

Create a real-time payment against a credit card or bank account

create_realtime_payment · Risk: low · Retry: safe

Inputs

  • payerId · string · Optional, Select an existing payer for this payment
  • useExistingPayer · boolean · Optional, Check if you want to use an existing payer instead of creating a new one
  • fullName · string · Optional, Full name of the payer (use this OR First Name + Last Name)
  • firstName · string · Optional, First name of the payer (use this OR Full Name)
  • lastName · string · Optional, Last name of the payer (use this OR Full Name)
  • email · string · Optional, Email address of the payer
  • mobileNumber · string · Optional, Australian 10-digit mobile number (non-international)
  • amount · number · Required, Payment amount in cents (e.g., $10.50 = 1050)
  • applicationFee · number · Optional, Optional additional fee in cents (Managed Merchants Only)
  • description · string · Optional, Optional description for the payment (visible to payer, max 1000 characters)
  • sourceId · string · Optional, Existing payment source ID to use (leave empty to use default or create new source)
  • token · string · Optional, Credit card or bank account token from capture script (for new payment source)
  • surcharge · array · Optional, Select source types to surcharge (pass fees to customer)
  • nonce · string · Optional, Optional one-time-use reference to prevent double submissions
  • metadata · string · Optional, Free text field for storing state or accounting integration data
Add Source to Payer · Read

Add a payment source (bank account or credit card) to an existing payer

add_source_to_payer · Risk: low · Retry: safe

Inputs

  • payerId · string · Required, Select the payer to add a payment source to
  • sourceType · string · Required, Type of payment source to add
  • useToken · boolean · Optional, Use a token from the capture script instead of manual bank account details
  • token · string · Optional, The token created by the Pinch capture script (for both bank accounts and credit cards)
  • ipAddress · string · Optional, IP address of the payer (required for token-based sources)
  • bankAccountNumber · string · Optional, The bank account number (only for manual bank account entry)
  • bankAccountBsb · string · Optional, The BSB (Bank-State-Branch) number (only for manual bank account entry)
  • bankAccountName · string · Optional, The name on the bank account (only for manual bank account entry)
Create or Update Scheduled Payment · Read

Create a new scheduled payment or update an existing one

create_or_update_scheduled_payment · Risk: low · Retry: safe

Inputs

  • paymentId · string · Optional, Enter an existing payment ID to update, or leave empty to create a new payment
  • payerId · string · Required, Select the payer for this scheduled payment
  • amount · number · Required, Payment amount in cents (e.g., $10.50 = 1050)
  • transactionDate · string · Required, The date to attempt the transaction
  • description · string · Optional, Optional description for the payment (visible to payer, max 1000 characters)
  • sourceId · string · Optional, Optional: ID of the payment source to use. If omitted, the first valid source will be used
  • surcharge · array · Optional, Select source types to surcharge (pass fees to customer)
  • applicationFee · number · Optional, Optional additional fee in cents (Managed Merchants Only)
  • nonce · string · Optional, Optional one-time-use reference to prevent double submissions
Add Subscription · Read

Create a subscription between a payer and a plan

add_subscription · Risk: low · Retry: safe

Inputs

  • planId · string · Required, Select the plan for this subscription
  • payerId · string · Required, Select the payer for this subscription
  • totalAmount · number · Optional, Required for percentage-based plans: total amount in cents (e.g., $100.00 = 10000)
  • startDate · string · Optional, When the subscription should start. Leave blank for immediate start
  • sourceId · string · Optional, Optional: Specific payment source ID to use. If omitted, a source will be automatically selected
  • surcharge · array · Optional, Select source types to surcharge (pass fees to customer)
Find Event · Read

Find an event using the Event ID

find_event · Risk: low · Retry: safe

Inputs

  • eventId · string · Required, The Event ID in evt_XXXXXXXXXXXXXX format
Find Payer · Read

Find a payer by their Payer ID

find_payer · Risk: low · Retry: safe

Inputs

  • payerId · string · Required, The Payer ID in pyr_XXXXXXXXXXXXX format
Find Subscription · Read

Find a subscription using the Subscription ID

find_subscription · Risk: low · Retry: safe

Inputs

  • subscriptionId · string · Required, The Subscription ID in sub_XXXXXXXXXXXXXX format

Triggers

Bank Results Event · Webhook

Triggers when a bank account transaction returns (may result in dishonour status)

Payer Created · Webhook

Triggers when a new payer record is created

Payer Updated · Webhook

Triggers when a payer record is updated

Realtime Payment · Webhook

Triggers when a realtime payment is executed

Payment Created · Webhook

Triggers when a payment is created (via Save Payment endpoint or Subscription)

Subscription Created · Webhook

Triggers when a subscription is created for a payer

Subscription Cancelled · Webhook

Triggers when a subscription is cancelled

Subscription Complete · Webhook

Triggers when a subscription is run to completion

Refund Created · Webhook

Triggers when a refund is created

Refund Updated · Webhook

Triggers when a refund is updated (e.g., status change)

Scheduled Process · Webhook

Triggers when scheduled payments are processed (daily on business days)

Transfer Created · Webhook

Triggers when a transfer is created to settle funds to a merchant

Dispute Created · Webhook

Triggers when a dispute is created

Dispute Updated · Webhook

Triggers when a dispute is updated

Setup

Setup

  1. Add the Pinch Payments connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Application ID (username), required.
  • Secret Key (password), required; stored as a sensitive connection value.
  • Environment (environment), required.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-pinch-payments@0.0.10; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 8 actions and 14 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Runtime execution evidence is managed separately from package metadata.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Pinch Payments connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-pinch-payments@0.0.10 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com