API Reference
Welcome to the Mopay API reference documentation. Here you'll find comprehensive details about all our API endpoints, request/response formats, authentication methods, and error handling.
Base URL
https://service.mopay-ng.com/?req=your_endpointAll API requests should be made to this base URL followed by the specific endpoint path.
Authentication
Learn how to authenticate with the Mopay API
- API Keys
- HMAC-based Authentication
- OAuth 2.0
Request Format
Understanding request format and error handling
- Request Structure
- Error Codes
- Rate Limiting
API Endpoints
User Authentication & Profile
Endpoints for user registration, login, and profile management
User Registration
Create and register a new user account
user_profile_createUser Login
Sign in to an existing Mopay account
user_profile_loginGoogle Login
Sign in using Google authentication
user_google_loginUser Logout
Disconnect device from account
user_profile_logoutAuthentication Info
Get authentication information
user_authenticationUser Profile Info
Get user account information
user_profile_get_infoUpdate User Profile
Modify user account details
user_profile_updateWallet & Payments
Endpoints for managing user wallets, deposits, and transfers
Wallet Info
Retrieve user wallet information
user_wallet_get_infoWallet History
Get wallet transaction history
user_wallet_historyCreate Deposit Order
Create a wallet deposit order
user_deposit_order_createFetch Deposit Orders
Fetch wallet deposit orders
user_deposit_order_fetchTransfer Funds
Create wallet transfer transaction
user_transfer_createVerify Transfer Recipient
Verify recipient before transfer
user_transfer_check_receiverServices & Billers
Endpoints for service categories, billers, and bill payments
Service Categories
Fetch service categories
service_category_fetchService Billers
Fetch service billers
service_biller_fetchService Biller Items
Fetch service biller items
service_biller_item_fetchVerify Customer ID
Verify customer details
service_customer_verifyPurchase Airtime
Create airtime purchase
service_airtime_purchasePay Bills
Pay bills using wallet balance
service_bill_paymentNotifications & Messaging
Endpoints for managing user notifications, notices, newsletter subscriptions, and location data.
File Management
Endpoints for uploading, fetching, and managing files
Support & Resources
Endpoints for FAQs, tutorials, and support
Admin & Staff
Endpoints for admin users and staff members
Analytics & Monitoring
Endpoints for system analytics and monitoring
System Services
Endpoints for core system services and utilities