Start here

Getting started

Core setup and request conventions to get your integration live quickly.

Quickstart

Get authenticated and make your first request in minutes.

API v1
Base URL
All API requests are relative to: https://rewards.invatixtech.com/api/v1
Get a JWT access token

Use for server-to-server / mobile clients. (See Swagger for full schema.)

curl -X POST "https://rewards.invatixtech.com/api/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "user@example.com",
    "password": "Password123!",
    "mfa_code": "123456"
  }'
Call an authenticated endpoint

Include the access token in the Authorization header.

curl "https://rewards.invatixtech.com/api/v1/auth/me" \
  -H "Authorization: Bearer <access_token>"
rule

Conventions

Auth modes, content types, and common response patterns.

Authentication modes
  • verified JWT (recommended for API clients): send Authorization: Bearer <token>.
  • cookie Session (same-origin SPA): call https://rewards.invatixtech.com/api/v1/auth/csrf and send X-CSRFToken on state-changing requests.
JSON & headers
Use Content-Type: application/json and send JSON bodies for POST endpoints.
Request tracking

You can send X-Request-ID and RuCoin will echo it back (plus X-Response-ID and X-Response-Time) for tracing. 

curl "https://rewards.invatixtech.com/api/v1/health" \
  -H "X-Request-ID: 8b2cb7f1-9b0c-4b1d-9f30-2f7d3b8c1234"
Response envelope

Most endpoints return a consistent wrapper for success and errors. 

{
  "success": true,
  "status_code": 200,
  "request_id": "...",
  "response_id": "...",
  "message": "Success",
  "code": "success",
  "data": { },
  "meta": { }
}
{
  "success": false,
  "status_code": 400,
  "request_id": "...",
  "response_id": "...",
  "message": "Validation failed",
  "code": "validation_error",
  "errors": { },
  "data": null
}

Reference

API catalog

Browse categorized endpoints first, then drill down into full OpenAPI details.

category

API reference (categorized)

High-level categories with endpoint lists. For schemas, use Swagger/ReDoc.

Reference
settings

settings Core Infrastructure

Health checks and lightweight utilities.

API
Health check
https://rewards.invatixtech.com/api/v1/health
GET
Pincode lookup
https://rewards.invatixtech.com/api/v1/pincode/lookup
GET
vpn_key

vpn_key Identity & Authentication

JWT tokens, session auth, MFA, password reset, and user onboarding.

API
JWT token access
https://rewards.invatixtech.com/api/v1/auth/token
POST
Refresh JWT token
https://rewards.invatixtech.com/api/v1/auth/token/refresh
POST
Revoke JWT token
https://rewards.invatixtech.com/api/v1/auth/logout
POST
User registration
https://rewards.invatixtech.com/api/v1/auth/register
POST
Resend reg-verification
https://rewards.invatixtech.com/api/v1/auth/register/resend-verification
POST
Request email OTP
https://rewards.invatixtech.com/api/v1/auth/otp/request
POST
Verify email address
https://rewards.invatixtech.com/api/v1/auth/email/verify
POST
Resend email verification
https://rewards.invatixtech.com/api/v1/auth/email/resend
POST
Get current user profile
https://rewards.invatixtech.com/api/v1/auth/me
GET
Change password (auth)
https://rewards.invatixtech.com/api/v1/auth/password/change
POST
Reset password request
https://rewards.invatixtech.com/api/v1/auth/password/reset
POST
Reset password confirm
https://rewards.invatixtech.com/api/v1/auth/password/reset/confirm
POST
Check MFA enabling status
https://rewards.invatixtech.com/api/v1/auth/mfa/status
GET
Initialize MFA setup
https://rewards.invatixtech.com/api/v1/auth/mfa/setup
POST
Verify & enable MFA
https://rewards.invatixtech.com/api/v1/auth/mfa/setup/verify
POST
Disable MFA (requires auth)
https://rewards.invatixtech.com/api/v1/auth/mfa/disable
POST
Get CSRF token
https://rewards.invatixtech.com/api/v1/auth/csrf
GET
Session-based login
https://rewards.invatixtech.com/api/v1/auth/session/login
POST
Session-based logout
https://rewards.invatixtech.com/api/v1/auth/session/logout
POST
business

business Organization & Tenant Management

Tenant profile, products/features, UI context, roles, and branding.

API
Manage tenant profile
https://rewards.invatixtech.com/api/v1/tenant/profile
GET/POST
Tenant product inventory
https://rewards.invatixtech.com/api/v1/tenant/products
GET/POST
Tenant active features
https://rewards.invatixtech.com/api/v1/tenant/features
GET/POST
Get UI session context
https://rewards.invatixtech.com/api/v1/tenant/context
GET
Branding context (marketing / pre-login)
https://rewards.invatixtech.com/api/v1/tenant/public-context
GET
Tenant branding endpoints
https://rewards.invatixtech.com/api/v1/tenant/branding
GET
List roles for assignment
https://rewards.invatixtech.com/api/v1/tenant/assignable-roles
GET
groups

groups User & Team Management

Team directory and tenant-scoped RBAC feature mappings.

API
Team member directory
https://rewards.invatixtech.com/api/v1/tenant/users
GET/POST
RBAC feature mapping
https://rewards.invatixtech.com/api/v1/tenant/role-features
GET/POST
verified_user

verified_user Verification & Compliance

Tax identity, bank verification, documents, and Cashfree verification workflows.

API
Tax identity (GST/PAN)
https://rewards.invatixtech.com/api/v1/tenant/tax
GET/POST
Compliance bank profiles
https://rewards.invatixtech.com/api/v1/tenant/bank-accounts
GET/POST
KYC document vault
https://rewards.invatixtech.com/api/v1/tenant/documents
GET/POST
Cashfree verification sync
https://rewards.invatixtech.com/api/v1/tenant/cashfree
GET/POST
Verify PAN via Cashfree
https://rewards.invatixtech.com/api/v1/tenant/cashfree/verify-pan
POST
Verify GSTIN via Cashfree
https://rewards.invatixtech.com/api/v1/tenant/cashfree/verify-gstin
POST
Verify Bank (Penny Drop)
https://rewards.invatixtech.com/api/v1/tenant/cashfree/verify-bank-account
POST
Verify UPI ID presence
https://rewards.invatixtech.com/api/v1/tenant/cashfree/verify-upi
POST
Verify Aadhaar Identity
https://rewards.invatixtech.com/api/v1/tenant/cashfree/verify-aadhaar
POST
Cashfree verification webhook
https://rewards.invatixtech.com/api/v1/kyc/cashfree/webhook
POST
account_balance_wallet

account_balance_wallet Loyalty & Wallet Operations

Wallet balances, transfers, and points operations.

API
List user digital wallets
https://rewards.invatixtech.com/api/v1/wallets
GET
Wallet balance & history
https://rewards.invatixtech.com/api/v1/wallets/{id}
GET
P2P wallet transfer
https://rewards.invatixtech.com/api/v1/wallets/transfer
POST
Top-up / Credit wallet
https://rewards.invatixtech.com/api/v1/wallets/{id}/credit
POST
Loyalty membership list
https://rewards.invatixtech.com/api/v1/loyalty/accounts
GET
Points status & tier
https://rewards.invatixtech.com/api/v1/loyalty/accounts/{id}
GET
Issue loyalty points
https://rewards.invatixtech.com/api/v1/loyalty/accounts/{id}/points
POST
storefront

storefront Merchant & Catalogue

Rewards inventory, redemptions, and product catalogue discovery.

API
Browse reward inventory
https://rewards.invatixtech.com/api/v1/rewards
GET
Reward details & terms
https://rewards.invatixtech.com/api/v1/rewards/{id}
GET
Redeem via points
https://rewards.invatixtech.com/api/v1/rewards/{id}/redeem
POST
Product catalogue search
https://rewards.invatixtech.com/api/v1/catalogue
GET
code

code Developer Resources

Schema discovery and interactive API documentation.

API
Download OpenAPI JSON
https://rewards.invatixtech.com/api/schema/
GET
Interactive Swagger UI
https://rewards.invatixtech.com/api/docs/
GET
Clean ReDoc interface
https://rewards.invatixtech.com/api/redoc/
GET
OpenAPI schema (v1)
https://rewards.invatixtech.com/api/v1/schema
GET
Swagger UI (v1)
https://rewards.invatixtech.com/api/v1/docs/swagger
GET
ReDoc (v1)
https://rewards.invatixtech.com/api/v1/docs/redoc
GET
list_alt

All APIs (Detailed & categorized)

Full endpoint catalog generated from OpenAPI. Each category includes method, route, auth requirement, parameters, request body, response codes, and operation ID.

Full
24 categories 139 endpoints
Admin Messages
4 endpoints
Permalink
List admin messages sent to me
/api/v1/admin-messages
GET
Messages sent by admin to the current user — list, mark read, unread count.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: admin_messages_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Mark all admin messages as read
/api/v1/admin-messages/read-all
POST
Messages sent by admin to the current user — list, mark read, unread count.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: admin_messages_read_all_create
Unread admin message count
/api/v1/admin-messages/unread-count
GET
Messages sent by admin to the current user — list, mark read, unread count.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: admin_messages_unread_count_retrieve
Mark admin message as read
/api/v1/admin-messages/{id}/read
POST
Messages sent by admin to the current user — list, mark read, unread count.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: admin_messages_read_create
Parameters: id (path, string, required)
Authentication
JWT token, refresh, logout, MFA, OTP, email verification and password management.
Permalink
Get CSRF token
/api/v1/auth/csrf
GET
Return the CSRF token for same-origin cookie-based requests. SPA should send it as X-CSRFToken header.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_csrf_retrieve
Resend verification email
/api/v1/auth/email/resend
POST
Resend the email verification link. Requires authentication.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_email_resend_create
Verify email
/api/v1/auth/email/verify
POST
Verify email using the token from the verification email link.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_email_verify_create
Logout
/api/v1/auth/logout
POST
Blacklist the refresh token. Send the refresh token in the request body; then discard both tokens client-side.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_logout_create
Current user
/api/v1/auth/me
GET
Return the authenticated user's profile (id, email, tenant_id, role, MFA status, permissions, etc.).
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_me_retrieve
MFA disable
/api/v1/auth/mfa/disable
POST
Disable MFA. Requires current password for security.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_mfa_disable_create
MFA setup (get QR)
/api/v1/auth/mfa/setup
GET
Start authenticator MFA setup. Returns secret and QR code image (base64). Then POST to verify.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_mfa_setup_retrieve
MFA setup (verify and enable)
/api/v1/auth/mfa/setup/verify
POST
Verify authenticator code and enable MFA. Requires verification_code from setup init.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_mfa_setup_verify_create
MFA status
/api/v1/auth/mfa/status
GET
Return whether MFA is enabled and the method (authenticator, otp, etc.).
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_mfa_status_retrieve
Request OTP
/api/v1/auth/otp/request
POST
Send a one-time code to the user's email or phone. Only when OTP MFA is enabled.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_otp_request_create
Change password
/api/v1/auth/password/change
POST
Change password for the authenticated user. Requires old_password and new_password.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_password_change_create
Request password reset
/api/v1/auth/password/reset
POST
Request a password reset email. Always returns 200 to avoid email enumeration.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_password_reset_create
Confirm password reset
/api/v1/auth/password/reset/confirm
POST
Set new password using uid and token from reset email link.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_password_reset_confirm_create
Register (disabled)
/api/v1/auth/register
GET
Self-registration is permanently disabled. All users are created by administrators.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_register_retrieve
Register (disabled)
/api/v1/auth/register
POST
Self-registration is permanently disabled. All users are created by administrators.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_register_create
Session login
/api/v1/auth/session/login
POST
Login with email/password; session cookie is set. If MFA is enabled, first call returns mfa_required; send mfa_code in a second POST.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_session_login_create
Session logout
/api/v1/auth/session/logout
POST
Logout and invalidate the session. SPA should then clear client state.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_session_logout_create
Obtain tokens
/api/v1/auth/token
POST
Obtain JWT access and refresh tokens. Send email and password; if MFA is enabled, also send mfa_code.
Auth: No Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: auth_token_create
Refresh token
/api/v1/auth/token/refresh
POST
Obtain a new access token using a valid refresh token.
Auth: No Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: auth_token_refresh_create
Billing
8 endpoints
Permalink
Get revenue report
/api/v1/billing/revenue
GET
Revenue reporting API.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: billing_revenue_retrieve
List invoices
/api/v1/invoices
GET
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: invoices_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Create invoice
/api/v1/invoices
POST
Create a new invoice for the current tenant.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: invoices_create
Get invoice detail
/api/v1/invoices/{id}
GET
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: invoices_retrieve
Parameters: id (path, string, required)
Download invoice PDF
/api/v1/invoices/{id}/download
GET
Download invoice as PDF.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: invoices_download_retrieve
Parameters: id (path, string, required)
Mark invoice as paid
/api/v1/invoices/{id}/mark-paid
POST
Mark an invoice as paid (manual payment recording).
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: invoices_mark_paid_create
Parameters: id (path, string, required)
Initiate payment
/api/v1/invoices/{id}/pay
POST
Initiate a payment for an invoice via a payment gateway.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: invoices_pay_create
Parameters: id (path, string, required)
Send invoice email
/api/v1/invoices/{id}/send
POST
Send invoice PDF via email.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: invoices_send_create
Parameters: id (path, string, required)
Cashfree Verification
Trigger and track Cashfree bank/document verification.
Permalink
List verification requests
/api/v1/tenant/cashfree
GET
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: tenant_cashfree_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Submit verification
/api/v1/tenant/cashfree
POST
Unified endpoint to submit various verification types (bank_account, document, pan, etc.).
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: tenant_cashfree_create
Verify Aadhaar
/api/v1/tenant/cashfree/verify-aadhaar
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_aadhaar_create
Verify bank account
/api/v1/tenant/cashfree/verify-bank
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_bank_create
Verify CIN
/api/v1/tenant/cashfree/verify-cin
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_cin_create
Verify Driving License
/api/v1/tenant/cashfree/verify-dl
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_dl_create
Verify document
/api/v1/tenant/cashfree/verify-document
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_document_create
Verify GSTIN
/api/v1/tenant/cashfree/verify-gstin
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_gstin_create
Verify PAN
/api/v1/tenant/cashfree/verify-pan
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_pan_create
Verify Passport
/api/v1/tenant/cashfree/verify-passport
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_passport_create
Verify UPI
/api/v1/tenant/cashfree/verify-upi
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_upi_create
Verify Voter ID
/api/v1/tenant/cashfree/verify-voter-id
POST
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_verify_voter_id_create
Get verification request
/api/v1/tenant/cashfree/{id}
GET
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tenant_cashfree_retrieve
Parameters: id (path, string, required)
Common
1 endpoints
Permalink
Lookup pincode
/api/v1/pincode/lookup
GET
Get city, district, state for a 6-digit Indian pincode. Proxies to postalpincode.in.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: pincode_lookup_retrieve
Health
API health, readiness and version checks.
Permalink
health_list
/api/v1/health
GET
Check if API is healthy.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: health_list
health_ready_retrieve
/api/v1/health/ready
GET
Check if API is ready to accept requests.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: health_ready_retrieve
health_version_retrieve
/api/v1/health/version
GET
Get API version and build information.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: health_version_retrieve
Landing
5 endpoints
Permalink
List FAQs
/api/v1/landing/faqs
GET
Return all active FAQs, optionally filtered by category.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: landing_faqs_list
List platform metrics
/api/v1/landing/metrics
GET
Return all active platform metrics.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: landing_metrics_list
List downloadable resources
/api/v1/landing/resources
GET
Return all active download resources.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: landing_resources_list
Public status check
/api/v1/landing/status-check
GET
Public status check endpoint. Query: ?reference_id=KYC-2026-00123 Returns the status of a KYC/application by reference ID.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: landing_status_check_retrieve
List testimonials
/api/v1/landing/testimonials
GET
Return all active testimonials.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: landing_testimonials_list
marketplace
5 endpoints
Permalink
Marketplace wallet balance (points available)
/api/v1/marketplace/balance
GET
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: marketplace_balance_retrieve
Checkout with points (RuGift order)
/api/v1/marketplace/checkout
POST
Auth: Yes Params: 0 Request Body: application/json (optional) Responses: 200 Operation ID: marketplace_checkout_create
marketplace_orders_retrieve
/api/v1/marketplace/orders
GET
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: marketplace_orders_retrieve
marketplace_products_list
/api/v1/marketplace/products
GET
Cached RuGift catalogue (sync via management command / Celery).
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: marketplace_products_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
marketplace_products_retrieve
/api/v1/marketplace/products/{id}
GET
Cached RuGift catalogue (sync via management command / Celery).
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: marketplace_products_retrieve
Parameters: id (path, string, required)
Marketplace
RuGift marketplace products, checkout, orders.
Permalink
Marketplace entry (redirect targets for web and API clients)
/api/v1/marketplace/entry
GET
Returns recommended browser paths and marketplace API prefixes. Use `resolved_flow` to choose tenant portal vs public marketplace host.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: marketplace_entry_retrieve
Notifications
6 endpoints
Permalink
List my notifications
/api/v1/notifications
GET
List notifications for the current user.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: notifications_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Get notification preferences
/api/v1/notifications/preferences
GET
In-app notification center — list, mark read, preferences.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: notifications_preferences_retrieve
Get notification preferences
/api/v1/notifications/preferences
PATCH
In-app notification center — list, mark read, preferences.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: notifications_preferences_partial_update
Mark all notifications as read
/api/v1/notifications/read-all
POST
In-app notification center — list, mark read, preferences.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: notifications_read_all_create
Unread notification count
/api/v1/notifications/unread-count
GET
In-app notification center — list, mark read, preferences.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: notifications_unread_count_retrieve
Mark notification as read
/api/v1/notifications/{id}/read
POST
In-app notification center — list, mark read, preferences.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: notifications_read_create
Parameters: id (path, string, required)
Prefund
10 endpoints
Permalink
List active prefund receiver accounts
/api/v1/prefund/accounts
GET
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: prefund_accounts_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Get prefund receiver account
/api/v1/prefund/accounts/{id}
GET
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: prefund_accounts_retrieve
Parameters: id (path, string, required)
List prefund requests
/api/v1/prefund/requests
GET
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: prefund_requests_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Create prefund request (tenant admin only)
/api/v1/prefund/requests
POST
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: prefund_requests_create
Get prefund request detail
/api/v1/prefund/requests/{id}
GET
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: prefund_requests_retrieve
Parameters: id (path, string, required)
Assign prefund request to internal staff
/api/v1/prefund/requests/{id}/assign
POST
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: prefund_requests_assign_create
Parameters: id (path, string, required)
Confirm OTP and finalize approve/reject (super admin)
/api/v1/prefund/requests/{id}/decision/otp/confirm
POST
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: prefund_requests_decision_otp_confirm_create
Parameters: id (path, string, required)
Request OTP for final approve/reject (super admin)
/api/v1/prefund/requests/{id}/decision/otp/request
POST
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: prefund_requests_decision_otp_request_create
Parameters: id (path, string, required)
Request clarification on prefund request
/api/v1/prefund/requests/{id}/request-clarification
POST
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: prefund_requests_request_clarification_create
Parameters: id (path, string, required)
Move prefund request to under review
/api/v1/prefund/requests/{id}/review
POST
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: prefund_requests_review_create
Parameters: id (path, string, required)
Redemption Management
4 endpoints
Permalink
Approve a redemption
/api/v1/rewards/redemptions/{id}/approve
POST
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_redemptions_approve_create
Parameters: id (path, string, required)
Cancel a redemption (refunds points)
/api/v1/rewards/redemptions/{id}/cancel
POST
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_redemptions_cancel_create
Parameters: id (path, string, required)
Fulfill a redemption
/api/v1/rewards/redemptions/{id}/fulfill
POST
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_redemptions_fulfill_create
Parameters: id (path, string, required)
Reject a redemption (refunds points)
/api/v1/rewards/redemptions/{id}/reject
POST
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_redemptions_reject_create
Parameters: id (path, string, required)
Reward Programs
6 endpoints
Permalink
List tenant reward programs
/api/v1/rewards/programs
GET
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: rewards_programs_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Create program
/api/v1/rewards/programs
POST
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: rewards_programs_create
Get program
/api/v1/rewards/programs/{id}
GET
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: rewards_programs_retrieve
Parameters: id (path, string, required)
Update program
/api/v1/rewards/programs/{id}
PUT
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: rewards_programs_update
Parameters: id (path, string, required)
Partially update program
/api/v1/rewards/programs/{id}
PATCH
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_programs_partial_update
Parameters: id (path, string, required)
Delete program
/api/v1/rewards/programs/{id}
DELETE
Programs for mapping coins, channels, and external refs (manager or tenant admin).
Auth: Yes Params: 1 Request Body: None Responses: 204 Operation ID: rewards_programs_destroy
Parameters: id (path, string, required)
rewards
8 endpoints
Permalink
rewards_list
/api/v1/rewards
GET
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: rewards_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
rewards_create
/api/v1/rewards
POST
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: rewards_create
rewards_redemptions_list
/api/v1/rewards/redemptions
GET
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: rewards_redemptions_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
rewards_redemptions_retrieve
/api/v1/rewards/redemptions/{id}
GET
Admin/manager view for managing redemption statuses. Supports: approve, fulfill, reject, cancel actions.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: rewards_redemptions_retrieve
Parameters: id (path, string, required)
rewards_retrieve
/api/v1/rewards/{id}
GET
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: rewards_retrieve
Parameters: id (path, string, required)
rewards_update
/api/v1/rewards/{id}
PUT
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: rewards_update
Parameters: id (path, string, required)
rewards_partial_update
/api/v1/rewards/{id}
PATCH
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_partial_update
Parameters: id (path, string, required)
rewards_destroy
/api/v1/rewards/{id}
DELETE
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 1 Request Body: None Responses: 204 Operation ID: rewards_destroy
Parameters: id (path, string, required)
Rewards
Reward catalog, redemptions.
Permalink
User's redemption history
/api/v1/rewards/my-redemptions
GET
Reward catalog management (tenant-scoped). - GET: list/retrieve rewards - POST: create reward (manager+) - POST /{id}/redeem/: redeem a reward - GET /my-redemptions/: user's redemption history
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: rewards_my_redemptions_retrieve
Redeem a reward
/api/v1/rewards/{id}/redeem
POST
Redeem a reward using the tenant wallet balance.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: rewards_redeem_create
Parameters: id (path, string, required)
Support
Ticket management, comments, status updates.
Permalink
List tickets
/api/v1/tickets
GET
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: tickets_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Create ticket
/api/v1/tickets
POST
Use TicketCreateSerializer for input, TicketSerializer for output.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: tickets_create
Canned responses
/api/v1/tickets/canned-responses
GET
Get pre-built canned responses for common ticket replies.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tickets_canned_responses_retrieve
SLA compliance metrics
/api/v1/tickets/sla-metrics
GET
Get SLA compliance metrics for all tickets.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tickets_sla_metrics_retrieve
Get ticket detail
/api/v1/tickets/{id}
GET
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tickets_retrieve
Parameters: id (path, string, required)
Assign ticket
/api/v1/tickets/{id}/assign
POST
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tickets_assign_create
Parameters: id (path, string, required)
Change ticket status
/api/v1/tickets/{id}/change-status
POST
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tickets_change_status_create
Parameters: id (path, string, required)
Add comment to ticket
/api/v1/tickets/{id}/comments
POST
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tickets_comments_create
Parameters: id (path, string, required)
List comments for ticket
/api/v1/tickets/{id}/comments-list
GET
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tickets_comments_list_retrieve
Parameters: id (path, string, required)
Ticket status history
/api/v1/tickets/{id}/history
GET
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tickets_history_retrieve
Parameters: id (path, string, required)
Rate ticket (satisfaction survey)
/api/v1/tickets/{id}/rate
POST
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tickets_rate_create
Parameters: id (path, string, required)
tenant
6 endpoints
Permalink
tenant_branding_retrieve
/api/v1/tenant/branding
GET
GET: return current tenant branding (logo_url, primary/secondary colors) PATCH/POST: update tenant branding (logo upload supported). Requires tenant_admin role.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tenant_branding_retrieve
tenant_branding_create
/api/v1/tenant/branding
POST
GET: return current tenant branding (logo_url, primary/secondary colors) PATCH/POST: update tenant branding (logo upload supported). Requires tenant_admin role.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tenant_branding_create
tenant_cashfree_update
/api/v1/tenant/cashfree/{id}
PUT
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_cashfree_update
Parameters: id (path, string, required)
tenant_cashfree_partial_update
/api/v1/tenant/cashfree/{id}
PATCH
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: tenant_cashfree_partial_update
Parameters: id (path, string, required)
tenant_cashfree_destroy
/api/v1/tenant/cashfree/{id}
DELETE
Trigger and list Cashfree verification requests for bank accounts or documents. Requires tenant context and tenant_admin role.
Auth: Yes Params: 1 Request Body: None Responses: 204 Operation ID: tenant_cashfree_destroy
Parameters: id (path, string, required)
tenant_self_api_keys_retrieve
/api/v1/tenant/self-api-keys/{id}
GET
Tenant admin self-service API keys; creation blocked until ops approves allowlist entries.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tenant_self_api_keys_retrieve
Parameters: id (path, string, required)
Tenant API Keys
3 endpoints
Permalink
List organization API keys
/api/v1/tenant/self-api-keys
GET
Tenant admin self-service API keys; creation blocked until ops approves allowlist entries.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: tenant_self_api_keys_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Create API key (requires approved network allowlist)
/api/v1/tenant/self-api-keys
POST
Tenant admin self-service API keys; creation blocked until ops approves allowlist entries.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 201 Operation ID: tenant_self_api_keys_create
Revoke API key
/api/v1/tenant/self-api-keys/{id}
DELETE
Tenant admin self-service API keys; creation blocked until ops approves allowlist entries.
Auth: Yes Params: 1 Request Body: None Responses: 204 Operation ID: tenant_self_api_keys_destroy
Parameters: id (path, string, required)
Tenant Context
Tenant branding and context for SPA.
Permalink
Get tenant context
/api/v1/tenant/context
GET
Return current tenant's branding and context (name, logo, theme) for SPA. Tenant from request or user's account.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tenant_context_retrieve
Get public tenant context by slug
/api/v1/tenant/public-context
GET
Return tenant name, logo, and theme by slug for login-page branding. No auth required.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tenant_public_context_retrieve
Tenant Documents
Upload and manage tenant documents for verification.
Permalink
List documents
/api/v1/tenant/documents
GET
Tenant documents for verification (e.g. business proof). Supports Cashfree verification. Requires tenant context and manager role or above.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: tenant_documents_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Upload document
/api/v1/tenant/documents
POST
Upload a document; optionally set verify=true to trigger Cashfree verification.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 201 Operation ID: tenant_documents_create
Get document
/api/v1/tenant/documents/{id}
GET
Tenant documents for verification (e.g. business proof). Supports Cashfree verification. Requires tenant context and manager role or above.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: tenant_documents_retrieve
Parameters: id (path, string, required)
Update document
/api/v1/tenant/documents/{id}
PUT
Tenant documents for verification (e.g. business proof). Supports Cashfree verification. Requires tenant context and manager role or above.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (required) Responses: 200 Operation ID: tenant_documents_update
Parameters: id (path, string, required)
Partially update document
/api/v1/tenant/documents/{id}
PATCH
Tenant documents for verification (e.g. business proof). Supports Cashfree verification. Requires tenant context and manager role or above.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: tenant_documents_partial_update
Parameters: id (path, string, required)
Delete document
/api/v1/tenant/documents/{id}
DELETE
Tenant documents for verification (e.g. business proof). Supports Cashfree verification. Requires tenant context and manager role or above.
Auth: Yes Params: 1 Request Body: None Responses: 204 Operation ID: tenant_documents_destroy
Parameters: id (path, string, required)
Tenant Users
User accounts management within tenant.
Permalink
Request account deletion (GDPR)
/api/v1/auth/account/delete
POST
Self-service account deletion. Anonymizes personal data.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_account_delete_create
Update user profile
/api/v1/auth/profile
PATCH
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: auth_profile_partial_update
List assignable roles
/api/v1/tenant/assignable-roles
GET
Return roles that can be assigned when creating users. Source: backend RoleDefinition.
Auth: Yes Params: 0 Request Body: None Responses: 200 Operation ID: tenant_assignable_roles_retrieve
tickets
1 endpoints
Permalink
tickets_partial_update
/api/v1/tickets/{id}
PATCH
Tickets for authenticated users. Non-staff see only their own tickets; staff see all.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: tickets_partial_update
Parameters: id (path, string, required)
Transactions
Transaction history and details.
Permalink
List transactions
/api/v1/transactions
GET
List transactions. Supports filtering by status, currency, date range.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: transactions_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
Transaction analytics
/api/v1/transactions/analytics
GET
Get transaction analytics summary.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: transactions_analytics_retrieve
Parameters: days (query, integer)
Get transaction
/api/v1/transactions/{id}
GET
Transaction endpoints: list, retrieve, refund, void, analytics.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: transactions_retrieve
Parameters: id (path, string, required)
List disputes for transaction
/api/v1/transactions/{id}/disputes
GET
List disputes for a transaction.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: transactions_disputes_retrieve
Parameters: id (path, string, required)
Raise dispute on transaction
/api/v1/transactions/{id}/raise-dispute
POST
Create a dispute on a transaction.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: transactions_raise_dispute_create
Parameters: id (path, string, required)
Refund transaction
/api/v1/transactions/{id}/refund
POST
Refund a completed transaction (full or partial). Staff only.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: transactions_refund_create
Parameters: id (path, string, required)
Void pending transaction
/api/v1/transactions/{id}/void
POST
Void a pending transaction. Staff only.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: transactions_void_create
Parameters: id (path, string, required)
wallets
5 endpoints
Permalink
wallets_list
/api/v1/wallets
GET
List and retrieve current user's wallets (balance check). User sees only their own wallets. For external tenant users, wallet scope is restricted to request tenant.
Auth: Yes Params: 3 Request Body: None Responses: 200 Operation ID: wallets_list
Parameters: ordering (query, string), page (query, integer), search (query, string)
wallets_transfer_create
/api/v1/wallets/transfer
POST
Transfer amount from one wallet to another (Flow 6). Requester must own from_wallet (or be staff). Amount > 0; atomic.
Auth: Yes Params: 0 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: wallets_transfer_create
wallets_retrieve
/api/v1/wallets/{id}
GET
List and retrieve current user's wallets (balance check). User sees only their own wallets. For external tenant users, wallet scope is restricted to request tenant.
Auth: Yes Params: 1 Request Body: None Responses: 200 Operation ID: wallets_retrieve
Parameters: id (path, string, required)
wallets_credit_create
/api/v1/wallets/{id}/credit
POST
Credit wallet (staff or internal). POST with amount, optional reference. Idempotency-Key required; duplicate requests return same response.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: wallets_credit_create
Parameters: id (path, string, required)
wallets_debit_create
/api/v1/wallets/{id}/debit
POST
Debit wallet via API. POST with amount, optional reference. Idempotency-Key required; duplicate requests return same response.
Auth: Yes Params: 1 Request Body: application/json, application/x-www-form-urlencoded, multipart/form-data (optional) Responses: 200 Operation ID: wallets_debit_create
Parameters: id (path, string, required)

Operate

Operations and docs

Use route references for implementation and day-2 operations.

route

All routes (reference)

Operational URLs for the RuCoin website (marketing, login, legal) and the operator portal.

home Website routes
Site
Landing
https://rewards.invatixtech.com/
GET
Developer docs
https://rewards.invatixtech.com/developer/
GET
Write to us
https://rewards.invatixtech.com/write-to-us/
POST
Login
https://rewards.invatixtech.com/auth/login/
GET
Privacy
https://rewards.invatixtech.com/privacy/
GET
Terms
https://rewards.invatixtech.com/terms/
GET
Contact
https://rewards.invatixtech.com/contact/
GET
Privacy policy
https://rewards.invatixtech.com/privacy-policy/
GET
Terms of service
https://rewards.invatixtech.com/terms-of-service/
GET
dashboard Portal routes
Portal
Dashboard overview
https://rewards.invatixtech.com/admin/dashboard/
GET
Tenants directory
https://rewards.invatixtech.com/admin/tenants/
GET
Onboard new tenant
https://rewards.invatixtech.com/admin/tenants/create/
GET/POST
Tenant deep-dive
https://rewards.invatixtech.com/admin/tenants/<id>/
GET
Feature flags config
https://rewards.invatixtech.com/admin/tenants/<id>/features/
GET
API key management
https://rewards.invatixtech.com/admin/tenants/<id>/api-keys/
GET
Bulk tenant operations
https://rewards.invatixtech.com/admin/tenants/bulk-action/
GET/POST
Staff & User management
https://rewards.invatixtech.com/admin/users/
GET
RBAC role definitions
https://rewards.invatixtech.com/admin/access/roles/
GET
User group management
https://rewards.invatixtech.com/admin/access/groups/
GET
System-wide permissions
https://rewards.invatixtech.com/admin/access/permissions/
GET
Loyalty program ROI
https://rewards.invatixtech.com/admin/loyalty/overview/
GET
Loyalty ledger search
https://rewards.invatixtech.com/admin/loyalty/accounts/
GET
Points velocity metrics
https://rewards.invatixtech.com/admin/loyalty/analytics/
GET
Reward inventory
https://rewards.invatixtech.com/admin/rewards/catalog/
GET
Redemption history
https://rewards.invatixtech.com/admin/rewards/redemptions/
GET
Direct store catalogue
https://rewards.invatixtech.com/admin/store/catalogue/
GET
Delivery audit logs
https://rewards.invatixtech.com/admin/notifications/logs/
GET
System & Audit logs
https://rewards.invatixtech.com/admin/logs/
GET
Security event monitor
https://rewards.invatixtech.com/admin/logs/security/
GET
Admin personal profile
https://rewards.invatixtech.com/admin/profile/
GET
Account/Portal settings
https://rewards.invatixtech.com/admin/settings/
GET
Secure portal exit
https://rewards.invatixtech.com/admin/logout/
GET
vpn_key Auth routes (web)
Auth
Auth cover
https://rewards.invatixtech.com/auth/
GET
Login
https://rewards.invatixtech.com/auth/login/
GET/POST
Register
https://rewards.invatixtech.com/auth/register/
GET/POST
Logout
https://rewards.invatixtech.com/auth/logout/
GET/POST
MFA verify
https://rewards.invatixtech.com/auth/mfa/verify/
POST
MFA status
https://rewards.invatixtech.com/auth/mfa/status/
GET
MFA setup
https://rewards.invatixtech.com/auth/mfa/setup/
GET
Backup codes
https://rewards.invatixtech.com/auth/mfa/backup-codes/
GET
Password reset
https://rewards.invatixtech.com/auth/password/reset/
GET
Password change
https://rewards.invatixtech.com/auth/password/change/
GET