Overview
Consumer-facing documentation for the Challanwala organization API.
The Challanwala organization API gives your team a secure external interface for:
- discovering supported vehicle types
- listing the cities available to your organization
- searching challans by vehicle registration number
- generating payment links for selected challans
- receiving webhook events for key lifecycle updates
Quickstart
Generate your API secret, choose an environment, and make your first authenticated call.
Authentication
Learn how bearer-secret auth works, how key rotation behaves, and what failures to expect.
Endpoints
Reference pages for metadata, location lookup, challan search, and payment-link APIs.
Webhooks
Verify signed webhook payloads for challan search and payment-link lifecycle events.
What this API is for
This documentation is written for organization teams integrating Challanwala into their own internal tooling, customer support flows, billing operations, or reconciliation pipelines.
The API is intentionally scoped. It focuses on the external workflows your team needs to complete and does not describe internal storage models, admin-only controls, or internal processing details.
Base conventions
- All organization API endpoints are rooted at
/api/v1/organization-api. - Every request must include
Authorization: Bearer YOUR_API_SECRET. - Success responses use the shape
{ "success": true, "data": ... }. - Error responses use the shape
{ "success": false, "message": "...", "errors": [...] }. - Your examples switch between the currently selected environment, shown below.
Recommended while wiring up and validating your integration.
Typical integration flow
- Generate an API secret from the organization settings screen.
- Store it securely and use it as a bearer token.
- Call
rc-typesandlocationsonce to prepare user input. - Search challans by RC number.
- Generate a payment link from the challans you want to collect.
- Poll payment-link status or subscribe to webhooks for lifecycle updates.
What is intentionally not covered
External contract only
These docs describe the stable consumer-facing behavior of the organization API. They intentionally exclude internal source orchestration, admin configuration internals, database concerns, and internal processing jobs.