e-RUPI Integration GuideVersion 2.0.0

API Endpoint:

Use the following base URLs to access the e-RUPI API endpoints for different environments:

Note: The exact endpoints differ for Generator and Vendor partners. Use the appropriate endpoint paths based on your partner type.

Required Headers:

Include the following headers in your API requests for authentication and tracking:

• X-API-KEY: Unique key assigned to authenticate requests.
  (required)(string)
• X-API-SECRET: Secret token for secure server-to-server communication.
  (required)(string)
• X-PARTNER-ID: Identifier provided to partner for request tracking.
  (required)(string)

Note: Ensure these headers are included in every API request to avoid authentication errors. You can generate a new X-API-SECRET from the portal at any time; once a new secret is generated, the previous one will be immediately disabled for security.

IP Whitelisting

For enhanced security, API requests are only accepted from whitelisted IP addresses. You can add and manage your server's public IP addresses directly in the e-RUPI Partner Portal (where you also obtain your API credentials). Requests from non-whitelisted IPs will be blocked automatically.

Obtain Credentials

Please visit the e-RUPI Partner Portal to register and obtain your API credentials, including:

• X-API-KEY
• X-API-SECRET
• X-PARTNER-ID

Sample Requests (cURL)

Below are generic examples of making authenticated requests to the e-RUPI APIs. Replace the {{base_url}} with either the production or UAT base URL as per your environment. Also, replace the {{endpoint}} with the specific endpoint for your partner type (Generator or Vendor).

POST Example:

curl -X POST \
  {{base_url}}/{{endpoint}} \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your-api-key" \
  -H "X-API-SECRET: your-api-secret" \
  -H "X-PARTNER-ID: your-partner-id" \
  -d '{
    "{{field1}}": "value1",
    "{{field2}}": "value2",
    "{{field3}}": {
      "{{subField}}": "value"
    }
  }'

GET Example:

curl -X GET \
  {{base_url}}/{{endpoint}}?{{queryParam}}={{value}} \
  -H "X-API-KEY: your-api-key" \
  -H "X-API-SECRET: your-api-secret" \
  -H "X-PARTNER-ID: your-partner-id"

Integration Support

For assistance during the integration process, please contact e-RUPI support at help@meribachat.in