Overview

PayMidWare is middleware: your software integrates to one API, and PayMidWare talks to whichever of the 21 payment gateways each of your merchants actually uses. Card and bank details never pass through your server or ours; you collect them with the gateway's own hosted fields and send PayMidWare the token.

A merchant can also have a key of its own, scoped to that one merchant, for a business that integrates directly. See Keys, environments and headers.

Core endpoints

Endpoint	Purpose
POST /api/merchant-accounts	Create one of your merchants (provider key).
PUT /api/merchant-accounts/{ref}/credentials/{gateway}	Set that merchant's gateway credentials (write-only).
POST /api/payments/charge	Charge, and capture, refund, void and check status under /api/payments/{gateway}/....
/api/merchant-accounts/{ref}/customers	Create, list and look up customers (by customerId or your own accountNumber), and vault their payment methods.
/api/merchant-accounts/{ref}/products, /product-categories, /tax-rates, /locations	The merchant's product catalog, named tax rates and locations.
/api/merchant-accounts/{ref}/invoices	Create, send, read, embed and void invoices.
/api/merchant-accounts/{ref}/scheduled-payments	One-time and recurring charges, plus customer-approved schedule requests.
/api/short-links	Short links on myezurl.com for your own pages: create, list, count clicks, revoke.
/api/merchant-accounts/{ref}/signatures	E-signature add-on: send a document for signature, follow its status, download the signed PDF.
/api/merchant-accounts/{ref}/quickbooks, /quickbooks-desktop, /salesforce, /crm/{crm}, /bigcommerce, /woocommerce	Status, sync now and disconnect for each integration.
GET /api/gateways	List every gateway PayMidWare supports.

The interactive reference (Swagger) lists every operation with its request and response shapes. It has three views: the complete developers reference, the provider operations, and the operations a merchant's own key can call.