Processor: Payworks
ZTZenoti Docs Team Updated September 5, 2026 2 min readGuide
Payworks is a V1 payment processor configured at the center level. It supports card payments through integrated card readers and terminals, primarily serving Canada. Stored accounts and tokenization are not supported β Payworks is a terminal-centric processor.
Before you begin
Permission: Center-level payment configuration access is required.
Payworks merchant-side prerequisites
- Active Payworks merchant account via your Canadian acquirer.
- Terminal pairing β each physical card reader must be activated against your merchant ID.
Credentials
| Field | Source / owner | What to enter |
|---|---|---|
| Merchant ID | Payworks merchant portal / account representative | The MID (Merchant Identifier) issued on activation. |
| API key (or password) | Payworks merchant portal | Authenticates API calls. Treat as sensitive. |
Network requirements
| Direction | Port | Protocol | Why |
|---|---|---|---|
| Outbound from Zenoti / POS (Point of Sale) to Payworks API | 443 | HTTPS | Charge, refund, status |
| Outbound from card reader to Payworks | 443 | HTTPS | Terminal-integrated payments |
Payworks capabilities in Zenoti
| Capability | Supported |
|---|---|
| Sale (terminal) | Yes |
| Refund | Yes |
| Void | [SOURCE GAP β PM VERIFY: no VoidTransaction override in PayworksProcessor.cs. Same-day cancellations may route through the refund flow.] |
| Pre-authorize and capture | [SOURCE GAP β PM VERIFY: does not confirm.] |
| Terminal (POS) | Yes |
| Stored accounts | No (CanProcessorSaveCards = false) |
| Recurring payments | No |
| Global tokenization | No |
Capability correction (April 2026): That is incorrect β Payworks is terminal-only in the Zenoti integration.
Configure Payworks
- At the center level, navigate to Configuration > Payments > Settings (the center-scope caption of the Payments row).
- Select Payworks as the payment processor.
- Enter the Merchant ID and API key.
- Select Save.
- Select Test to verify.
Process a payment
- Staff selects Payworks on the invoice.
- Guest taps / inserts / swipes on the Payworks card reader.
- Result returned; invoice closes on approval.
Process a refund
Refund β dual-system perspective
| System | What happens |
|---|---|
| Zenoti | Negative payment line; Collections report shows the refund row. |
| Payworks | Refund record in the Payworks merchant portal linked to the original transaction. Match key: Payworks transaction reference or Zenoti invoice number. |
Edit or reverse a posted payment
| Invoice state | What you can do |
|---|---|
| Open | Remove the payment line and refund if a charge has gone through. |
| Closed | Reopen if permissions allow, or post a compensating refund. Original line preserved. |
Failure modes
| Failure mode | User-visible symptom | Resolution |
|---|---|---|
| Payworks unreachable | Terminal fails with communication error. | Check HTTPS and Payworks status. |
| Authentication | All transactions fail with auth error. | Re-verify Merchant ID / API key with Payworks. |
| Card declined | Issuer decline at the terminal. | Guest retries. |
| Amount out of range | Terminal rejects. | Per-MID limits; contact Payworks. |
| Currency mismatch | Rejected. | Payworks settles in CAD. Confirm center currency. |
| Settlement failure | Approved but missing from daily batch. | Raise with Payworks using the transaction reference. |
| Terminal pairing mismatch | Terminal refuses to transact. | Re-pair the terminal with Payworks support. |
Settlement and reconciliation
Payworks settlement is typically next-business-day (T+1) in Canada, excluding weekends and Canadian federal / provincial holidays. [SOURCE GAP β PM VERIFY: exact window for your MCC.]
| Source | Report / view | Match key |
|---|---|---|
| Zenoti | Collections report (filter: Payment Method = Payworks) | Payworks transaction reference + Zenoti invoice number |
| Payworks | Payworks merchant portal settlement report | Same fields |
Recommended cadence: daily.
Tips
- Contact your Payworks account representative if you encounter authentication errors after entering your credentials.
- Verify that your Payworks terminal device is activated and linked to your merchant account.
- Payworks is terminal-only in Zenoti. For online payments or card-on-file, pair Payworks with a second processor at the center.
Was this article helpful?
Your feedback helps us improve our documentation.