Introduction
What Partner Gateway is, and how this reference is organized.
Partner Gateway is a standalone API that lets external business partners integrate MTN Mobile Money deposits/withdrawals and crypto buy/sell without touching the internal ATM backend directly. Partners authenticate with a simple AppId/AppKey pair; the gateway enforces per-partner IP whitelisting, rate limits, and service enablement in one place, and internal backend changes never leak through to a partner's integration.
Public base path: api/v1/....
What's in this reference
- Getting started — the shape of an onboarding conversation and your first authenticated request.
- Authentication & signing — AppId/AppKey, and the HMAC signature required on money-out actions.
- Idempotency — safely retrying a request that may have already succeeded.
- Sandbox testing — deterministic test outcomes keyed on magic MSISDNs, and on-demand callback replay.
- Webhooks & callbacks — how delivery, signing, and retries work.
- Errors — the
GW-xxxstatus vocabulary every response uses. - Partner ledger — the double-entry record of every settled transaction.
- API Reference — every endpoint, generated directly from the gateway's own OpenAPI spec, with live try-it-out.
Services
| Service | What it does |
|---|---|
KYC_MOMO | Look up whether an MSISDN is a known, active MoMo account |
MOMO_DEPOSIT | Collect money from a customer's MoMo wallet into the platform |
MOMO_WITHDRAWAL | Pay money out to a customer's MoMo wallet (signature required) |
CRYPTO_QUOTE | Get a live price quote for a crypto buy/sell |
CRYPTO_BUY | Convert a customer's local-currency deposit into crypto |
CRYPTO_SELL | Convert a customer's crypto back into local currency (signature required) |
TXN_STATUS | Poll any of the above transactions for its current status |
Each service is enabled per partner independently — a partner only ever sees 403 GW-403-FORBIDDEN
for a service they haven't been granted, never a 404 that would reveal whether the route exists.