Api Guidelines

NSDL PAN Plugin – Complete Guide

Comprehensive documentation for NSDL PAN WordPress Plugin

Plugin Overview

PAN Application System

Complete NSDL PAN card application system with user management and transaction logging

REST API

Powerful REST API for integrating PAN applications with external websites

WooCommerce Integration

Automatic hit limit increase when users purchase mapped products

User Management

Complete user registration, approval, and limit management system

System Flow

1

User Registration

Users register and get approved by admin

→
2

Purchase Limits

Buy hit limits via WooCommerce or manual payment

→
3

Submit Applications

Submit PAN applications via form or API

→
4

NSDL Processing

Applications processed by NSDL with response logging

Installation & Setup

Step 1: Plugin Installation

1. Upload plugin folder to /wp-content/plugins/
2. Activate plugin from WordPress admin
3. Plugin will create required database tables automatically

Step 2: NSDL Configuration

Go to NSDL PAN → Settings → NSDL Configuration and configure:

  • JAR File Path
  • PFX Certificate details
  • Entity ID and DSC information
  • NSDL API URL

Step 3: General Settings

Configure general settings:

  • Default hit limit for new users
  • PAN application fee (₹107)
  • Auto approval settings
  • Email notifications

Step 4: WooCommerce Integration (Optional)

If using WooCommerce:

  • Install and activate WooCommerce
  • Create products for hit limits
  • Map products in Settings → WooCommerce Integration
  • Enable automatic limit addition

Available Shortcodes

[nsdl_registration_form]

Purpose: User registration form for NSDL services

Usage: Place on registration page

Example: [nsdl_registration_form]

[nsdl_user_dashboard]

Purpose: User dashboard with statistics and transaction history

Usage: Place on user account page

Example: [nsdl_user_dashboard]

[nsdl_pan_apply_form]

Purpose: Multi-step PAN application form

Usage: Place on PAN application page

Example: [nsdl_pan_apply_form]

[nsdl_limit_request_form]

Purpose: Form to request hit limit increase

Usage: Place on limit request page

Example: [nsdl_limit_request_form]

[nsdl_agent_details]

Purpose: Agent profile and statistics page

Usage: Place on agent profile page

Example: [nsdl_agent_details]

[nsdl_api_management]

Purpose: API key generation and management

Usage: Place on API management page

Example: [nsdl_api_management]

[nsdl_api_docs]

Purpose: Complete API documentation

Usage: Place on API documentation page

Example: [nsdl_api_docs]

[nsdl_api_test]

Purpose: API testing console

Usage: Place on API testing page

Example: [nsdl_api_test]

Admin Panel Features

Dashboard

  • Real-time statistics and metrics
  • Recent transactions overview
  • Quick action buttons
  • Revenue tracking

User Management

  • Approve/reject user registrations
  • Activate/deactivate user accounts
  • Manage hit limits
  • View user statistics

Transaction Management

  • View all PAN applications
  • Filter by status, date, user
  • Export transaction data
  • Delete transactions

Limit Requests

  • Approve/reject limit increase requests
  • View payment proofs
  • Bulk processing
  • Request history

User Panel Features

Registration & Profile

  • User registration with business details
  • Profile management
  • Agent details and statistics
  • Account status tracking

PAN Applications

  • Multi-step application form
  • eKYC and eSign support
  • Real-time validation
  • Application tracking

Limit Management

  • Request hit limit increase
  • Package-based purchasing
  • Manual payment with proof upload
  • Limit usage tracking

API Integration

  • Generate secure API keys
  • Complete API documentation
  • Live API testing console
  • Usage statistics

API Integration Guide

Getting Started with API

1

Generate API Key

Go to API Management and generate your API key

Shortcode: [nsdl_api_management]
2

Set Branch Code

Configure your branch code in profile settings

Used in all API requests
3

Read Documentation

Study the complete API documentation

Shortcode: [nsdl_api_docs]
4

Test API

Use the testing console to verify integration

Shortcode: [nsdl_api_test]
5

Integrate

Implement API calls in your website

Set return_url for response handling

Available Endpoints

Method Endpoint Purpose
POST /wp-json/nsdl-pan/v1/submit-application Submit PAN application
GET /wp-json/nsdl-pan/v1/check-status Check transaction status
GET /wp-json/nsdl-pan/v1/user-stats Get user statistics
POST /wp-json/nsdl-pan/v1/create-wp-user Create WordPress user

Key Features

WordPress Integration

Convert API users to WordPress users

Custom Branch Code

Each user can set their own branch code

Response Forwarding

NSDL responses sent to your return URL

Flexible Parent Details

Send either father or mother details

WooCommerce Integration

Setup WooCommerce Integration

1. Install WooCommerce

Install and activate WooCommerce plugin

2. Create Products

Create products for hit limits:

  • 10 PAN Applications – ₹1,070
  • 25 PAN Applications – ₹2,675
  • 50 PAN Applications – ₹5,350
  • 100 PAN Applications – ₹10,700

3. Map Products

Go to NSDL PAN → Settings → WooCommerce Integration

  • Enable WooCommerce integration
  • Map each product to hit limits
  • Set hit limit amount for each product

4. Automatic Processing

When users purchase mapped products:

  • Hit limits automatically added to user account
  • Email notification sent to user
  • Order notes added for tracking
  • Limit history logged

Benefits of WooCommerce Integration

Automatic Processing

No manual intervention needed

E-commerce Features

Full shopping cart experience

Payment Gateways

Use WooCommerce payment methods

Sales Tracking

Complete sales and revenue reports

Troubleshooting

Settings Not Saving

Solution: Check if you have proper admin permissions and WordPress nonce is working correctly.

API Key Not Working

Solution: Ensure user account is active and API key is properly generated. Check API logs for errors.

WooCommerce Integration Not Working

Solution: Verify WooCommerce is active, products are mapped correctly, and integration is enabled in settings.

Hit Limits Not Refunding

Solution: Check if auto refund is enabled in settings and transaction status is properly updated.

NSDL Submission Failing

Solution: Verify JAR file path, PFX certificate details, and NSDL URL in settings.

Need Help?

If you’re still experiencing issues:

  • Check WordPress error logs
  • Verify all file permissions
  • Test with minimal plugins active
  • Contact support with error details