Reseller API Reference

Welcome to the NexoraFox Reseller API documentation. This API allows external resellers to programmatically search catalog offerings, verify client accounts, register end-users, and generate payment links for service provisioning.

Authentication

Reseller requests must authenticate by sending the active reseller token key inside the request headers or request parameters.

To acquire your reseller key, go to the Admin dashboard settings and create a new Reseller API Key.

Error Handling

All responses return JSON payloads. If a query is successful, the payload includes "success": true. In the event of a failure, it will contain "success": false along with a detailed error message describing the reason.

List Categories

GET /categories

Retrieves all root service categories with their corresponding child categories. Useful for rendering navigation submenus or filters on the reseller side.

List Products

GET /products

Lists available catalog items with their corresponding price configurations and structural specs.

Query Parameters

Get Product Info

GET /products/{id}

Retrieves specific hardware specs, description, pricing tiers and metadata details for a particular service offering.

Check User Email

GET 🔑 Auth /users/check

Checks whether an email address is already registered on the cloud system. Resellers can use this to determine if they need to prompt the user to register or create their user account automatically.

Query Parameters

Create User

POST 🔑 Auth /users

Registers a new client account on the platform, automatically pre-verifying the email so they can log in immediately.

Request Body Parameters

Create Order

POST 🔑 Auth /orders

Generates a service checkout token and payment URL. If the email doesn't exist, passing the user_name creates the user automatically. Supports both new purchases (via product_id) and renewals (via service_id).

Request Body Parameters

Payment Callbacks

Admins can configure a webhook URL and/or success redirect URL in Admin > Settings > Reseller API. The webhook is sent server-to-server after a payment is verified, so it works even when the customer closes the browser.

Webhook

The configured URL receives a POST request with JSON:

{
    "event": "payment.completed",
    "data": {
        "order_id": 42,
        "token": "AbCdEf...",
        "status": "paid",
        "amount": 299.0,
        "currency": "INR",
        "transaction_id": "cf_order_123",
        "paid_at": "2026-09-04T12:00:00+00:00",
        "user": { "id": 5, "name": "John Doe", "email": "customer@example.com" },
        "service_id": 17,
        "invoice_id": 88,
        "service_status": "pending"
    }
}

If a webhook secret is configured, verify the X-NexoraFox-Signature header as sha256=HMAC_SHA256(raw_request_body, secret). Return a 2xx response after accepting the event.

Success Redirect

After the hosted payment page succeeds, the customer is redirected to the configured URL with event, order_id, token, status, amount, currency, and transaction_id query parameters. Use the webhook as the trusted server-side signal; the redirect is for updating the customer's browser.

Get Order Details

GET 🔑 Auth /orders/{token}

Check transaction status, payment execution state, currency amount, and service deployment status using the order token returned from the order creation endpoint.

List Your Orders

GET 🔑 Auth /orders

Paginated history of all orders created by the reseller API key. Ideal for reseller billing panels or bot administration summaries.

Get User Services

GET 🔑 Auth /user-services

Retrieves all cloud hosting packages, active nodes, billing intervals and deployment statuses associated with a specific customer email.

Query Parameters

Renew Service

POST 🔑 Auth /services/{id}/renew

Generates a renewal invoice and payment link specifically linked to an existing service/host. Use this to allow clients to renew active or suspended services.

Request Body Parameters