Build
API Reference
Quickstart
Information
Platform
API home document
get
Mobile readiness
Runtime feature readiness for the mobile app
get
Supported country metadata
get
Single country metadata
get
Service catalog for a country
get
Mobile support articles
get
Referral summary for the caller
get
Capture interest for a not-yet-enabled feature
post
Auth
Request an OTP code
post
Exchange an OTP code for a short-lived otpToken
post
Register an end-user and issue tokens
post
PIN login
post
Reset PIN using an OTP-authorized token
post
Rotate refresh token
post
Revoke a refresh token
post
Current end-user profile
get
Retry wallet provisioning for authenticated user
post
List active sessions
get
Revoke a session
delete
Wallets
Create wallet
post
List wallets for the authenticated user
get
Get wallet balance
get
Resolve a transfer recipient
post
Quote a transfer
post
Execute a wallet transfer
post
Recent wallet transactions
get
Search wallet transactions
get
Transaction detail
get
Recent transfer recipients
get
Available statements
get
Statement detail
get
Initiate cash-in
post
Buy airtime
post
Pay a bill
post
Sandbox developer top-up
post
Savings pots
Create a savings pot
post
List my savings pots
get
Savings pot detail
get
Update a savings pot
patch
Deposit into a savings pot
post
Withdraw from a savings pot
post
Virtual cards
Create virtual card
post
List my virtual cards
get
Card detail
get
Update card
patch
Freeze a card
post
Unfreeze a card
post
Beneficiaries
List my beneficiaries
get
Save beneficiary
post
Remove beneficiary
delete
KYC
Start KYC verification
post
My KYC history
get
Current KYC verification
get
KYC verification detail
get
Submit a document to a KYC verification
post
Cancel KYC verification
post
Documents
Submit a document to a KYC verification
post
Upload document metadata/content
post
Get a signed document URL
get
Delete a document
delete
Notifications
List notifications
get
Unread notification count
get
Mark notifications seen in bulk
post
Mark every notification seen
post
Mark one notification seen
post
Notification preferences
get
Update notification preferences
put
Devices
List device tokens
get
Register device token
post
Revoke current installation token
delete
Revoke device token by id
delete
Marketplace
List marketplace programmes
get
Create or update a marketplace programme
post
List marketplace opportunities
get
Create or update a marketplace opportunity
post
List marketplace participants
get
Create or update a marketplace participant
post
List marketplace opportunity assignments
get
Assign a marketplace participant to an opportunity
post
List marketplace milestones
get
Create or update a marketplace milestone
post
List marketplace milestone evidence
get
Create, update, or review milestone evidence
post
List marketplace payment-control instructions
get
Create or update a marketplace payment control
post
List marketplace payment execution attempts
get
Create or update a marketplace payment execution attempt
post
Apply a provider callback or reconciliation event
post
Contract vault
List contracts visible to the end-user
get
Query marketplace contract-vault records
get
Create or update a marketplace contract-vault record
post
List structured contract commitments
get
Create or update a structured contract commitment
post
List contract version proof metadata
get
Create or update contract version proof metadata
post
Apply a provider-neutral proof anchoring event
post
List external signature provider requests
get
Create or update an external signature provider request
post
Apply a signature provider callback or reconciliation event
post
List contract signature ceremony receipts
get
Create or update a contract signature ceremony receipt
post
List append-only contract history events
get
Append an idempotent contract history event
post
List contract extraction runs
get
Store extractor output and proposed commitments
post
Accept or reject a side-service extraction run
post
Plane B
List aliases
get
Create alias
post
Resolve alias
post
List institution API keys
get
Create institution API key
post
Revoke institution API key
delete
Update institution API key
patch
Query audit log
get
Audit log detail
get
List marketplace programmes
get
Create or update a marketplace programme
post
List marketplace opportunities
get
Create or update a marketplace opportunity
post
List marketplace participants
get
Create or update a marketplace participant
post
List marketplace opportunity assignments
get
Assign a marketplace participant to an opportunity
post
List marketplace milestones
get
Create or update a marketplace milestone
post
List marketplace milestone evidence
get
Create, update, or review milestone evidence
post
List marketplace payment-control instructions
get
Create or update a marketplace payment control
post
List marketplace payment execution attempts
get
Create or update a marketplace payment execution attempt
post
Apply a provider callback or reconciliation event
post
Query marketplace contract-vault records
get
Create or update a marketplace contract-vault record
post
List structured contract commitments
get
Create or update a structured contract commitment
post
List contract version proof metadata
get
Create or update contract version proof metadata
post
Apply a provider-neutral proof anchoring event
post
List external signature provider requests
get
Create or update an external signature provider request
post
Apply a signature provider callback or reconciliation event
post
List contract signature ceremony receipts
get
Create or update a contract signature ceremony receipt
post
List append-only contract history events
get
Append an idempotent contract history event
post
List contract extraction runs
get
Store extractor output and proposed commitments
post
Accept or reject a side-service extraction run
post
Read deployment manifest
get
Reload deployment manifest
post
Webhooks
List webhook subscriptions
get
Create webhook subscription
post
Delete webhook subscription
delete
Update webhook subscription
patch
List webhook deliveries
get
Replay webhook delivery
post
Observability
Process health
get
Dependency readiness
get
Prometheus metrics
get
Schemas
powered by Zudoku
Menu
HeritagePay API
HeritagePay API
Platform
Server
https://sandbox-heritagepay-api.paypm.net/api/v1
https://staging-heritagepay-api.paypm.net/api/v1
http://localhost:3000/api/v1
API home document
GET
https://sandbox-heritagepay-api.paypm.net/api/v1
/
API home document ›
Responses
200
Service metadata and documentation links.
ApiHome
name
​
string
service
​
string
version
​
string
documentation
​
object
Mobile readiness
