SwitchLock API
A double-entry financial ledger for the Zimbabwean market. Accept payments, hold funds in escrow, issue wallets, and process withdrawals — all through a single API built for compliance, integrity, and scale.
What can you build?
SwitchLock is a primitive — a financial engine you compose into products.
Marketplace Escrow
Hold buyer funds in escrow, release to sellers only when goods are confirmed. Built-in dispute resolution, milestone releases, and negotiation flows.
Escrow DocsDigital Wallet Platform
Issue multi-currency wallets (USD & ZiG) to your users. Accept deposits, process withdrawals, and query full transaction history with double-entry integrity.
Ledger DocsWhatsApp Payment Bot
Let buyers complete escrow payments entirely through WhatsApp. OTP verification, real-time status updates, and document collection — no app required.
WhatsApp DocsMulti-Tenant Payment Rail
Run a fully isolated ledger per company tenant. Each merchant gets its own accounts, API keys, fee configs, and administrator roles.
Tenant DocsHow the API is organised
Every resource lives under a versioned base path (/v1). All authenticated endpoints require an x-api-key header and a company context header x-company-id.
| Resource | Base Path | What it covers |
|---|---|---|
| Payments | /v1/payments | Payment links, deposits, EFT checkout, accept/reject payments |
| Escrow | /v1/escrow | Initiate, fund, release, dispute, and negotiate escrow settlements |
| Identity | /v1/identity | Create users, upload KYC documents, link national IDs |
| Ledger | /v1/ledger | Account statements, balances, transaction history, stats |
| Treasury | /v1/treasury | Withdrawals to bank, bank fund captures, fee configs |
| Companies | /v1/core/companies | Register tenants, manage API keys, administrators, KYB |
| Auth | /v1/auth | Dashboard login, token refresh, password reset |
| /v1/whatsapp | Meta webhook handlers, file upload, signed URL generation |
Start here
Register a company, get an API key, and generate your first payment link in under 5 minutes.
Understand API keys, Bearer tokens, company context, and idempotency headers before your first call.
Full endpoint reference with request shapes, response schemas, and curl examples for every route.
What's built in
Seamlessly track Zimbabwe Gold (ZiG) and USD side-by-side with no FX ambiguity.
Every cent is accounted for. Every debit has a credit. Math-verified at rest.
Built-in engines calculate and deduct Intermediated Money Transfer Tax and Withholding Tax automatically.
Safe retries on all financial mutations. Duplicate requests return the original result, never double-charge.
A full escrow state machine — PENDING → FUNDED → DELIVERED → RELEASED — with timeline events at every step.
Buyers can pay, verify identity, and receive receipts without ever leaving WhatsApp.
All SwitchLock API calls must originate from your secure backend. API keys embedded in frontend code are trivially extractable and could allow unauthorized fund movements on your account.