Get employee data from RazorpayX Payroll API

Introduction

This article is part of our in-depth HRIS API series, focused on one key use case, fetching employee data using the RazorpayX Payroll API. Whether you’re building internal payroll dashboards, automating HR workflows, or syncing payroll records, this step-by-step guide will help you do it right.

If you’d like a broader overview, including authentication, rate limits, and other use cases, check out our RazorpayX Payroll API Integration

Getting Employee Data from RazorpayX Payroll API

Prerequisites

Before you begin, ensure:

• You have valid RazorpayX Payroll API credentials (API ID and API Key or Partner Key and Client Key).
• Your Python environment is set up with the requests library.

1. Get Data for One Employee

API Endpoint:
https://payroll.razorpay.com/api/payroll

Python Example:

import requests

url = "https://payroll.razorpay.com/api/payroll"
headers = {
    "x-api-id": "your-api-id",
    "x-api-key": "your-api-key"
}
data = {
    "auth": {"id": "your-api-id", "key": "your-api-key"},
    "request": {"type": "payroll", "sub-type": "view-payroll"},
    "data": {"employee-id": 3, "payroll-month": "2020-12"}
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

2. Get Data for All Employees

There’s no bulk endpoint to fetch all employee data in one go. You’ll need to loop through employee IDs.

Python Example:

employee_ids = [1, 2, 3]  # Example employee IDs

for emp_id in employee_ids:
    data["data"]["employee-id"] = emp_id
    response = requests.post(url, json=data, headers=headers)
    print(response.json())

Common Pitfalls to Avoid

1. Invalid Credentials – Double-check your API ID and Key before sending requests.
2. Wrong Environment – Use production or sandbox URLs correctly.
3. Over-Authentication – Don’t include all four keys; use only one method.
4. Rate Limits – Implement retry logic to handle throttling.
5. Invalid Employee IDs – Validate IDs before sending requests.
6. Network Failures – Add timeout and retry mechanisms.
7. Improper Error Handling – Always parse JSON responses safely and handle 4xx/5xx codes.

Frequently Asked Questions

1. What authentication methods are supported?
RazorpayX supports API ID/Key and Partner/Client Key authentication.

2. Can I fetch data for multiple employees in one request?
No, you’ll need to iterate over employee IDs programmatically.

3. What is the base URL for API requests?
https://payroll.razorpay.com (production).

4. Is there a sandbox environment?
Yes, use https://opfin.np.razorpay.in for testing.

5. How should I handle API errors?
Monitor the HTTP status code and log the error message from the response body.

6. What request format does RazorpayX Payroll API use?
All requests are in JSON format.

7. How do I update employee details?
Use the designated update endpoint (not covered in this article).

Knit for RazorpayX Payroll API Integration

Integrating directly with RazorpayX Payroll can get complex, authentication, version changes, and maintenance add up fast. Knit simplifies this.
By connecting once with Knit’s unified API, you can:

• Access RazorpayX Payroll instantly, without managing tokens or auth flows.
• Scale integrations across HR and payroll platforms effortlessly.
• Reduce integration maintenance and engineering overhead.

Knit’s plug-and-play model makes payroll connectivity faster, cleaner, and more reliable, letting your team focus on building experiences, not integrations.