Getting started with the Pinch API
The starting point for your Pinch API integration
Core API Concepts
Here are some of the core concepts used by the API to get you started with how different entities interact. Read more about these API Core Concepts.
Merchant → your account and managed sub-accounts
Payer → who you're collecting money from
Source → bank accounts and credit cards (payment methods)
Agreement → direct debit authorisation (DDR)
Payment → the core collection request (scheduled or realtime), with Attempt as the execution sub-entity
Plan → reusable payment schedule templates
Subscription → a Plan bound to a Payer
Transfer → settlement of funds to the merchant's bank
Refund → returning money from a settled payment
Event → an audit/notification record of something happening
Webhook → push delivery of events to your server
Create a developer account
To get started register for a free Pinch Developer Account, this will give you access to the Pinch Developer Portal as well as access to the sandbox API which will allow you to start testing out API calls in a sandbox environment where you can safely use test credit cards without actually taking money.
Developer Pricing
Take a look at the Developer pricing for Pinch which outline all the fees associated with Pinch that you may encounter.
Get an SDK
Take a look at the available Pinch SDKs to get started with your integration or take a look at the Pinch Payments Github for other code samples or projects that may help you along.
Credit Card payments
Read through our Credit Card Payments Guide to help you through the process of taking Credit Card payments.
Direct Debit Payments
Read through our Direct Debit Payments Guide to help you through the process of taking Bank Account payments.
Managed Merchants
If you are looking to use Managed Merchants features where you want to create Pinch Merchant's for your clients so they can take Payments through your platform then take a look at our Managed Merchants Guide.
Zapier
Looking to integrate Pinch into Zapier? Take a look through our guides to get Zapier connected.
Updated 17 days ago