Roxindia API Authentication

To ensure secure access to the Roxindia API, we support two methods of authentication: passing the token in the query parameter for utility payment APIs and passing it in the header for all financial APIs. This guide will walk you through both methods.

Overview

API authentication is crucial for securing your API endpoints and ensuring that only authorized clients can access the services. Roxindia supports two authentication methods:

• Authentication via Query Parameter (Utility Payments)
• Authentication via Header (Financial APIs)

1. Authentication via Query Parameter (Utility Payments)

For utility payment APIs, include the access token in the URL as a query parameter:

GET /apiservice/utility_payments?token=YOUR_TOKEN

Example using curl:

curl -X GET "https://portal.roxindia.in/apiservice/utility_payments?token=YOUR_TOKEN"

Supported utility payments include electricity, water, broadband, and other similar services.

2. Authentication via Header (Financial APIs)

For financial APIs, include the access token in the Authorization header:

token: YOUR_ACCESS_TOKEN

Example using curl:

curl -X POST https://portal.roxindia.in/apiservice/v1/financial/endpoint \
              -H "token: YOUR_ACCESS_TOKEN"

Financial APIs include services such as domestic money transfers, AePS transactions, and payouts to vendors.

Obtaining an Access Token

To obtain an access token, log in to the Roxindia Developer API Portal:

1. Go to the Roxindia Developer API Portal.
2. Sign in with your account credentials.
3. Navigate to the Developer Api section.
4. Generate a new access token and copy it.

The access token will be used in the API requests as described in the sections above.

Token Expiry and Refresh

Currently, there is no specific lifespan for the access token. If you encounter any issues or if the token becomes invalid, you may need to generate a new token from the Developer API Portal.

Conclusion

By following these steps, you can securely authenticate and access the Roxindia API using either method based on the type of service. For more details, refer to the full API documentation available on the Roxindia Developer Portal.