Zimswitch Online Integration Options
Three integration paths for merchants and developers. Choose the approach that matches your technical capability and go-live timeline.
Test in Sandbox Advanced PaymentsCopy n Pay
LiveHosted payment widget checkout — shoppers enter card details on a secure gateway-hosted form while your server prepares the session and verifies results.
Who it is for: Merchants who want the fastest path to accept payments without building a custom checkout UI.
Typical use case: E-commerce checkout, donation pages, bill-pay portals and campaign payments with lower PCI scope.
Your server prepares a checkout via API, renders the payment widget on your page, and verifies the payment status after the shopper is redirected back.
Engagement Steps
- Contact your acquiring bank or Zimswitch to enable merchant credentials.
- Obtain UAT test credentials and configure your shopper result URL.
- POST to /v1/checkouts to prepare a payment session.
- Load the payment widget and let the shopper complete payment.
- GET the resourcePath on your server to verify final payment status.
Server-to-Server
Available in SandboxDirect backend API integration for custom checkout experiences, pre-authorisation, capture and back-office payment management.
Who it is for: Developers and enterprises building custom payment journeys with full backend control.
Typical use case: Custom checkout UIs, mobile backends, pre-auth/capture flows and synchronous or asynchronous card payments.
Your backend sends payment requests directly to the gateway API, handles redirects for async flows, and manages capture, refund and status operations server-side.
Engagement Steps
- Confirm PCI obligations with your security team and acquiring bank.
- Request API credentials and supported payment types (DB, PA, CP, RF).
- Implement server-side payment initiation and status verification.
- Test synchronous and asynchronous flows in UAT sandbox.
- Complete acquirer certification before production enablement.
Pay by Link
Requires EnablementGenerate and share secure payment links for invoices, campaigns, events and customer-not-present collections via email, chat or QR.
Who it is for: Charities, campaign managers, invoice merchants, call centres and organisations without a full e-commerce checkout.
Typical use case: WhatsApp or email payment requests, event tickets, invoice collection, in-store QR payments and social commerce.
Your server creates a payment link via API, you share it with the customer, and the customer pays on a branded hosted page. You verify payment status before fulfilment.
Engagement Steps
- Request Pay by Link enablement from your acquiring bank or Zimswitch.
- Create a payment link server-side with amount, currency and reference.
- Share the link via email, chat, QR or SMS (where enabled).
- Customer completes payment on the hosted page.
- Verify payment status via resourcePath before marking order or invoice as paid.
REST API Reference Overview
Full documentation pack available on request. Sandbox documentation covers UAT integration paths.
REST API Overview
Gateway REST endpoints for checkout, payment status and merchant operations.
Authentication
Bearer token authentication using entity ID and authorization header. Credentials are masked in admin panels.
Payment Initiation
POST /v1/checkouts to create a payment session with amount, currency and merchant transaction ID.
Payment Status Check
GET resource path returned from checkout to verify final payment state server-side.
Refund / Reversal
Back-office refund (RF) and reversal operations depend on acquirer enablement. Contact your bank for production APIs.
Webhooks / Callbacks
Configure shopper result URL and server-side resource path verification for payment notifications.
Pay by Link
Create shareable payment links, optional QR codes and link status management.
Error / Response Codes
Gateway result codes (000.xxx) and acquirer rsp_code values. Success includes rsp_code 00 and 51 per Zimswitch business rules.
How to Engage Banks and Zimswitch
- Identify your acquiring bank from the Partners page.
- Submit a merchant onboarding inquiry via the onboarding form.
- Zimswitch Innovation Hub coordinates credential provisioning and UAT access.
- Complete sandbox testing before requesting production enablement.
Contact: innovationhub@zimswitch.co.zw