Q App API & Developer Hub

Live System Documentation Endpoints

Direct links to all interactive HTML and API documentation controllers registered in the Django server.

Dispute WS Docs

Live HTML documentation for Dispute Chat WebSockets & Admin Mediation.

/api/disputes/documentation/ Open Dispute Docs

Chat WS Docs

Live HTML documentation for Direct & Group Chat WebSockets protocol.

/api/chats/documentation/ Open Chat Docs

Post Views WS Docs

Live HTML documentation for real-time post view counting WebSockets.

/api/posts/views/documentation/ Open Post Views Docs

Payment Gateway Docs

API JSON documentation endpoint for Q Payment Gateway integration.

/api/gateways/payments/docs/ Open Gateway Docs

System Integration & Architecture Guides

Markdown specifications for platform architecture, virtual accounts, KYC, and server deployment.

Gateway Integration Guide

Complete merchant guide for embedding Q Pay checkout SDK on web/mobile apps.

Read HTML Guide JSON Spec

Architecture Overview

Deep dive into Django backend, Redis channels, Celery async workers, and Azure stack.

Read Architecture Guide

Direct Funding Guide

Virtual account creation, direct bank transfer top-up, and webhook notifications.

Read Funding Guide

KYC & Face Recognition

Luxand Cloud facial capture integration, blue tick verification, and KYC workflows.

Read KYC Specs

Deployment & Operations

Production environment deployment, Gunicorn worker management, and SSL setup.

Read Deployment Guide

Docker Setup & Specs

Containerized environment setup, Redis, Celery beat, and postgres container configs.

Read Docker Specs

Q Payment Gateway SDK & Demos

Embeddable payment checkout solution for third-party websites and mobile applications.

Gateway Demo #1

Interactive checkout popup demo with live Q-Pay modal integration.

/api/gateways/payments/example/1 Launch Demo 1

Gateway Demo #2

Alternative merchant checkout flow with custom metadata payload.

/api/gateways/payments/example/2 Launch Demo 2

Q-Pay Minified JS SDK

Production ready minified JavaScript library snippet for merchants.

/static/js/q-pay.min.js View JS SDK

Q-Pay Source JS SDK

Unminified JS library source file for developer customization.

/static/js/q-pay.js View Source JS

Real-Time WebSockets Protocol Reference

Django Channels WebSocket endpoints for real-time messaging, dispute resolution, and push notifications.

Chat WebSocket

1-on-1 direct chat messaging, group room broadcasts, typing status, and read receipts.

ws://<host>/ws/chat/<room_id>/

View Chat WS Docs

Dispute WebSocket

Real-time dispute chat between buyer, seller, and admin mediators with live event payloads.

ws://<host>/ws/dispute/<dispute_id>/

View Dispute WS Docs

Notification WebSocket

Push notifications for wallet top-ups, referral commissions, delivery status, and system alerts.

ws://<host>/ws/notifications/

Group: user_{user_id} Real-time Push

Dispute Resolution & Support APIs

REST endpoints and WebSocket events for handling customer transaction disputes and admin mediation.

REST API

Create / List Disputes

File a new dispute for a transaction or query existing disputes.

/api/disputes/

DOCS ENDPOINT

Dispute Documentation

Interactive HTML guide for Dispute WebSocket payload schemas.

/api/disputes/documentation/

REST & WS

Dispute Messages

Fetch chat history or post messages to a dispute channel.

/api/disputes/<id>/messages/

ADMIN

Admin Dispute Control

Admin management dashboard to resolve or decline disputes.

/api/admin/disputes/

Chat & Social Messaging APIs

Endpoints for direct messaging, user search, group room creation, and chat management.

Direct Messages

List user conversations, start 1-on-1 chat, and retrieve messages.

GET /api/chats/
POST /api/chats/

Chat Docs API

Interactive HTML spec for Chat WebSocket protocol and payloads.

/api/chats/documentation/

Group Chats

Create group channels, add/remove group members, and set permissions.

GET /api/chats/groups/
POST /api/chats/groups/

Chat Attachments

Upload photos, videos, and documents inside chat conversations.

POST /api/chats/attachments/

Full API Module Registry

All REST API domain paths available on the Q App backend server.

Module Path	Description	Key Operations	Documentation Link
`/api/disputes/`	Disputes & Complaints	Create dispute, WebSocket messages, Resolve	/api/disputes/documentation/
`/api/chats/`	Chat & Messaging	Direct chat, Group chat, Real-time room events	/api/chats/documentation/
`/api/posts/`	Social Media Posts	Create posts, Comments, Likes, Views WS Docs	/api/posts/views/documentation/
`/api/gateways/`	Payment Gateway Suite	Merchant register, Payments initiate/verify	/api/gateways/payments/docs/
`/api/auth/`	Authentication & Accounts	Signup, Login, OTP, Reset Password, PIN	Swagger Auth Docs
`/api/wallets/`	Wallet & Balances	Balance query, Peer Transfer, Direct Funding	Swagger Wallet Docs
`/api/banks/`	Bank Account Verification	Bank list, NUBAN resolution, Saved accounts	Swagger Bank Docs
`/api/deliveries/`	Delivery & Logistics	Vendor management, Delivery status, Tracking	Swagger Delivery Docs
`/api/kycs/`	KYC & Security	Luxand facial verification, ID submit, Blue tick	Swagger KYC Docs
`/api/rewards/`	Referrals & Cashbacks	Referral code, Total earnings, Cashback claims	Swagger Rewards Docs
`/api/admin/`	Admin Dashboard API	System metrics, Bulk status, User approvals	Swagger Admin Docs