Biznoq API Reference

Integrate license payments, verify keys, and configure instant dynamic webhooks.

Introduction

Welcome to the Biznoq Developer API documentation. Using our secure REST APIs, you can programmatically create checkout order payloads for add-on licenses and tiered subscriptions. When a transaction status completes successfully, we trigger notifications to your custom webhooks to keep your databases fully synced.

Base URL: http://localhost:3000 or your production server domain.

Authentication

Every REST API request directed to our platform must include custom validation headers generated via your Admin Panel. If authentication credentials are invalid or missing, server nodes return an HTTP 401 Unauthorized response code.

Authentication HTTP Headers

x-api-key: biz_a5d3a2bbd99f4f6bbb46acbfd236be3b
x-api-secret: sec_default_secret_biznoq_2026_key_string

Create Add-on Order

Generates a dynamic payment order with our UPI gateway and returns a secure payment link.

POST /api/purchase

Initializes a checkout order flow for buying individual software add-ons.

Parameter	Type	Required	Description
addonId	Integer	Yes	The ID of the target add-on product in catalog database.
serialNo	String	Yes	Unique Busy Software Serial Number for validation locking.
buyerPhone	String	Yes	10-digit mobile phone number of customer.

Example Request Body (JSON)

{
  "addonId": 1,
  "serialNo": "B-12345678",
  "buyerPhone": "9460439200"
}

Example Response (200 OK)

{
  "success": true,
  "paymentUrl": "https://merchant.upigateway.com/order/checkout/payment_token_value",
  "licenseKey": "GA-ABCD-EFGH-IJKL"
}

Create Subscription Order

Generates subscription orders for tiered monthly or annual billing plans.

POST /api/plans/subscribe

Initializes a checkout order flow for subscription billing plans.

Parameter	Type	Required	Description
planId	Integer	Yes	The target billing plan ID from plans registry.
serialNo	String	Yes	Client software serial key to attach the subscription to.
buyerPhone	String	Yes	Contact phone number.
billingCycle	String	Yes	Either `monthly` or `yearly` billing duration.

Example Request Body (JSON)

{
  "planId": 2,
  "serialNo": "B-87654321",
  "buyerPhone": "9876543210",
  "billingCycle": "yearly"
}

Example Response (200 OK)

{
  "success": true,
  "paymentUrl": "https://merchant.upigateway.com/order/checkout/subscription_token_value",
  "subscriptionId": 42
}

Verify License Key

Retrieve activation validity status and parameters of any generated license key.

GET /api/purchase/status/:licenseKey

Queries database for structural fields associated with the license key.

Example Response (200 OK)

{
  "success": true,
  "license": {
    "licenseKey": "GA-X3R9-K9L2-M4P1",
    "addonName": "Smart Item Trading Analyzer",
    "addonVersion": "1.0.0",
    "serialNo": "B-12345678",
    "status": "verified",
    "activatedAt": "2026-05-29 18:47:32",
    "expiresAt": "2027-05-29"
  }
}

Webhook Callback Spec

Configuring a Webhook URL in your API Credentials pane ensures our gateway triggers an HTTP POST request to your system whenever a customer payment clears. Webhook handlers must return a 200 OK response code to acknowledge receipt.

Example Webhook JSON Body

{
  "status": "success",
  "client_txn_id": "TXN-1716942000000-8452",
  "txn_id": "UPI298452093845",
  "amount": "2999.00",
  "customer_mobile": "9460439200",
  "udf1": "trading-analyzer",
  "udf2": "B-12345678",
  "udf3": "GA-X3R9-K9L2-M4P1"
}