PayPM Platform · Developer documentation
Your next programme starts here.
Connect your customers. Move money with confidence. Build a wallet programme around the people you serve.
- ConnectCustomer identity & sessions
- TransactMoney flows & event delivery
- OperateControls & production readiness
A clear path forward
What are you building?
Mobile contracts, authentication and sessions for your customers and members.
Mobile integration TRANSACTMake every movement countMoney-flow idempotency, webhook subscriptions and delivery replay.
Money flows OPERATEReady your programmeOperator API keys, audit controls, contract records and milestones.
Go-live checklistPayPM Platform helps fintechs, enterprises, institutions, and networks build and operate branded wallet programmes for their own customers or members.
Environments
Scroll to compare all columns
| Environment | API | Partner Console | Backoffice |
|---|---|---|---|
| Sandbox | https://sandbox-heritagepay-api.paypm.net/api/v1 | https://sandbox-heritagepay.paypm.net | https://sandbox-heritagepay-backoffice.paypm.net |
| Staging | https://staging-heritagepay-api.paypm.net/api/v1 | https://staging-heritagepay.paypm.net | https://staging-heritagepay-backoffice.paypm.net |
The public developer documentation is served at https://developer.paypm.net.
Sandbox simulates money movement. Staging is wired for live money-flow validation and must be handled with production discipline.
API Planes
Scroll to compare all columns
| Plane | Used by | Credential | Examples |
|---|---|---|---|
| Plane A | Mobile end users | JWT bearer token | OTP, PIN login, wallets, transfers, KYC, notifications |
| Plane B | Operators and integrators | Institution API key, and HMAC where required | API keys, audit, webhooks, manifest, contract vault admin |
| Platform OIDC | Interactive product clients | ZITADEL at auth.paypm.net | Partner Console and PayPM Business login; product authorization remains separate |
ZITADEL authenticates subjects only. Product identity, tenant membership, and
roles are owned by PayPM Identity and each product. Standalone Marketplace is
enrolled internally during a compatibility period. Wallet mobile is money-only:
it does not mount Marketplace. Wallet GET /marketplace/my is compatibility
residue on the wallet host, not a live Wallet consumer contract. Business mobile
and the Marketplace SPA live-read standalone GET /api/v1/marketplace/my when
pointed at the Marketplace host. Operator writes stay on wallet Plane B. Do not
invent a Marketplace write API. See Authentication and
Marketplace Architecture.
Virtual cards and savings pots are not contracted and must not be treated as live product surfaces. See Money Flows.
Start with the Quickstart, then open the API Reference.
The live sandbox API does not currently serve Swagger at /api/v1/docs or
/api/v1/docs-json (both return 404). Use this portal's committed catalog.