Admin Panel

API Reference

v1.0

Integrate, automate, and build on top of the platform. Every request requires your personal API key.

REST · JSON
Introduction
AuthenticationYour API KeyEndpointsRate LimitingRBAC RolesWebhooksErrors

Base URL

/api/v1

All API requests should be made to this base URL. All responses return JSON. Authentication is required for every endpoint via the X-API-KEY header.

Format
JSON
Auth method
API Key
Protocol
HTTPS / REST
Authentication
Include your API key with every request

All API requests require your unique personal API key. Pass it in the X-API-KEY request header. Keys are unique per user — never share yours.

Example: GET /balance
curl -X GET "/api/v1/balance" \
 -H "X-API-KEY: YOUR_API_KEY" \
 -H "Content-Type: application/json"

Important Notes

  • Never expose your API key in client-side JavaScript or public repos.
  • Each user has a unique API key regardless of their role.
  • Regenerating a key immediately invalidates the previous one.
  • Your account will be suspended if misuse is detected.
Real-Time Core Gateway Registry
API Key

Your personal access token

Loading key...
Active
Header: X-API-KEY

Security Tip

Never share your key publicly.

API Endpoints
Click any endpoint to expand parameters and examples
GET
/balance

Get current account balance and wallet info

POST
/payments

Create a new payment order (Pay-in) to collect money from customers

GET
/payments

List all payment transactions with optional filters

GET
/payments/:id

Get a single payment record by transaction ID

GET
/payouts

List all payout requests with optional status filter

POST
/payouts

Create a new payout request to a bank account

GET
/profile

Get your account profile and merchant settings

Rate Limiting
API usage limits to ensure fair access and system stability
api_user
100 req/hr
Worker tier
merchant / partner
500 req/hr
Business tier
admin / super_admin
2,000 req/hr
Management tier

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining. When exceeded, a 429 is returned.

Role-Based Access
Endpoints enforce your role hierarchy automatically
super_admin
  • Full access to all endpoints
  • Manage any user and role
  • Access all financial data and reports
admin
  • Access payment endpoints
  • List and manage sub-users
  • View team transaction history
partner_api / merchant
  • Pay-in and pay-out endpoints
  • Create and manage api_users
  • View own transaction history
api_user
  • Balance and profile endpoints
  • Submit pay-in / pay-out requests
  • View own reports only
Webhook Events
Receive real-time notifications when payment statuses change

Configure your webhook URL in your Profile settings. We'll POST a JSON payload whenever a payment event occurs. Your server must respond with HTTP 200 to acknowledge.

Available Events
payment.completed
payment.failed
payout.processed
payout.rejected
user.created
user.suspended
Sample Payload
{
 "event": "payment.completed",
 "order_id": "TXN-2026-001",
 "amount": 5000,
 "currency": "INR",
 "status": "completed",
 "payer": "Jane Smith",
 "timestamp": "2026-04-05T06:00:00.000Z"
}
Error Responses
All errors follow a consistent JSON format
Error Response Format
{
 "success": false,
 "error": {
 "code": "invalid_api_key",
 "message": "The provided API key is invalid or does not exist.",
 "status": 401,
 "timestamp": "2026-04-05T06:00:00.000Z"
 }
}
400
missing_fields

Required parameters are missing

401
invalid_api_key

API key is missing or invalid

402
insufficient_balance

Not enough wallet balance

403
insufficient_permissions

Role does not have access

404
not_found

Record does not exist

409
duplicate_order_id

Order ID already exists

429
rate_limit_exceeded

Too many requests

500
database_error

Internal server error