Managed Merchants Payments Guide
This guide outlines the typical process for taking Payments using Managed Merchants.
To make use of these features you will require a verified Pinch Developer account.
Here is the process to follow to take payments for Managed Merchants:
Create Managed Merchant
Using your Master Merchant API credentials use the Create Managed Merchants endpoint to create managed merchants (Your clients)
Store Merchant Id
Make sure to store the Merchant Id in your system from the above response (this is a string identifier starting with mch_)
Subscribe to Webhooks
Make a call to the Create or Update Webhook Endpoint to setup a new webhook subscription for the newly created merchant. Take a look at the Events guide to understand the different types of events available to the webhook subscription.
Merchant Compliance
Once the managed merchant is created we will need to take them through compliance where we need identification and proof of business documents to be uploaded. Once you get to this part we can go into more detail on the info we require and see if you want to build into the API part of this or send them off to our form to handle it.
API Credentials
Use your Master Merchant API credentials along with the Current Merchant header with the Merchant Id of the client you are calling the API on behalf of (See Managed Merchants Guide )
Payment Collection Options
You have two options for collecting payments from your managed merchants' customers:
Option 1: Payment Links (Recommended for Quick Implementation)
Payment Links provide a hosted, secure payment experience without requiring you to build custom payment forms. This is ideal for:
- Quick implementation without frontend development
- One-off invoices and ad-hoc payments
- Sending payment requests via email, SMS, or chat
- Integrations with workflow tools (Zapier, n8n, Make, etc.)
To use Payment Links with Managed Merchants:
- Use the Create Payment Link endpoint with your Master Merchant API credentials and the Current Merchant header
- Share the returned URL with your customer via your preferred channel
- The customer completes payment on the Pinch-hosted checkout page
- Track payment status via webhook events (see Events Guide)
See the complete Payment Links Guide for detailed instructions and examples.
Option 2: Custom Payment Form (For Full Control)
If you need a fully customized payment experience integrated into your application, you can build your own payment form using tokenisation:
Form Elements
To create the form elements see the examples on the Tokenisation docs page Including the working credit card tokenisation example JsFiddle
Tokenisation
Your form widget will need to create a token from the payment details before submission then once you have the token that can be passed safely to your backend where it is used to make a call to the payment endpoint, if we are just looking at credit cards for this first pass then this will be the realtime payment endpoint
Create Payments
This endpoint will give you a response object containing an id for the payment (string identifier starting with pmt_) that you can then store as a reference to the payment (For later use with the webhooks if needed).
Got feedback on this feature?
Send an email to [email protected] or book in a chat with our API team.
Updated 7 days ago
