Developers / Guides / Records
Short links
Turn a long address into a short one on myezurl.com (for example https://myezurl.com/k7p2x9qd) for a text message, a QR code
or a printed receipt, and see how many times it was opened. It is open to every provider key and every merchant key; there is no separate sign-up.
A provider key sees every link the provider made; a merchant's own key sees only that merchant's links.
The short address answers with a plain redirect, with no page, no cookie and no tracking of the visitor: only the number of opens is kept. Revoking a link stops it at once (visitors see "This link is no longer available"), and the counts stay readable.
What can be shortened
A public https:// page on a real host name. These are refused with 400: http:// addresses, IP addresses, localhost and internal
names, addresses with a user name or password or an unusual port, addresses with spaces, other short-link services (bit.ly and the like), and myezurl.com itself. PayMidWare can
also block a domain it finds is abused. Make links to your own pages, such as receipts, invoices and add-a-card pages.
Endpoints
| Endpoint | Purpose |
|---|---|
| POST /api/short-links | Make a link. Body: targetUrl (required), and optionally purpose (a tag of up to 40 characters you can filter on), label (up to 120), clientReference (your own id, up to 100), expiresInDays or expiresAtUtc (not both), and merchantReference (a provider key naming one of its merchants). Returns 201 with code and shortUrl. |
| GET /api/short-links | List your links, newest first. Filters: merchantReference, status (active, expired, revoked), purpose, search (a code or client reference, or part of the address or label), page, pageSize (1 to 200, default 50). |
| GET /api/short-links/{code} | One link, with its total clickCount and lastClickedUtc. |
| GET /api/short-links/{code}/clicks?days=30 | The running total and the opens for each of the last N UTC days (1 to 365; days with none are 0). |
| DELETE /api/short-links/{code}?reason= | Revoke the link. Safe to repeat. |
Retrying safely, limits and errors
Send a clientReference (your invoice or order id) and a retry is harmless: the same reference with the same address returns the existing link with 200
instead of making a second one. The same reference with a different address is a 409 until the first link is revoked or expires.
Each merchant can create 2,000 links in any rolling 24 hours, and each provider (all its merchants together) 50,000; past that the answer is 429 with Retry-After.
A 403 means short links have been switched off for the account; a 503 means this environment has no short link domain set up yet.
sandbox.myezurl.com); they never
work in production. Each short-link call counts as one API request for the merchant it names, like any other call.