Developer guides
How to build against the PayMidWare API: keys and environments, payments, saved methods, invoices, scheduled payments, integrations and the gateway sandboxes.
Interactive reference. Every operation, with request and response shapes, is in the Swagger reference. Click Authorize, paste your key, and Try it out sends it for you.
Start here
Overview
What the API is, the two kinds of key and the core endpoints.
Quick start
From a sandbox key to a test charge in four calls.
Keys, environments and headers
Provider and merchant keys, sandbox and live, and the headers every call needs.
Payments
Saved payment methods
Vault a card or bank account once and charge it later.
ACH / eCheck payments
Charge a US bank account with the same charge call.
Records
Customers, products and tax rates
Customers, text consent, products, categories, tax rates and locations.
Invoices and the pay page
Create and send invoices, partial payments and embedding the pay page.
Scheduled and recurring payments
One-time and recurring charges, retries and customer-approved schedules.
E-signature
Send a document for signature and download the signed PDF.
Short links
Short links on myezurl.com for texts, QR codes and receipts.
Integrations
Accounting, CRM and store sync
QuickBooks, Salesforce, HubSpot, Dynamics 365, Zoho, NetSuite, BigCommerce and WooCommerce.
Gateway webhooks
The one address each gateway's webhooks go to.