Quick start

The shortest path from nothing to a test charge.

Get a sandbox key

Sign up for the sandbox. The PayMidWare team sets up your provider account and sends you an API key. It is shown exactly once and cannot be retrieved again, so keep it somewhere safe. Sandbox keys start with pmw_test_ and only work in the sandbox.

Create a merchant account

POST /api/merchant-accounts
X-Api-Key: <your key>

{ "externalReference": "store-001", "displayName": "My First Store" }

Set that merchant's gateway credentials

Get free test credentials for whichever gateway you are trying from the gateway sandbox directory, then:

PUT /api/merchant-accounts/store-001/credentials/Stripe
X-Api-Key: <your key>

{ "apiSecret": "sk_test_...", "environment": "Sandbox", "enabled": true }

Send a test charge

POST /api/payments/charge
X-Api-Key: <your key>
X-Merchant-Reference: store-001

{ "amount": { "value": 12.00, "currency": "USD" }, "gatewayName": "Stripe" }

Fastest way to explore: open the interactive reference, click Authorize, paste your X-Api-Key, and every Try it out call sends it for you. No separate HTTP client needed.

Card numbers never go through your server or ours. Collect card and bank details with the gateway's own hosted fields and send PayMidWare the token you get back. How that works.

Where next

Saved payment methods and ACH payments for charging a customer again later.
Invoices and the pay page when you want PayMidWare to host the payment page.
Scheduled payments for repeat billing.
When you are ready for production, each of your merchants needs its own merchant account and gateway account. Tell us where you are and we will help with whichever is missing.