e-RUPI Integration GuideVersion 2.0.0

e-RUPI is a digital payment solution that enables users to make cashless and contactless payments through QR codes or SMS-based vouchers. It is designed to facilitate seamless transactions for healthcare, education, subsidies, and more. This guide covers integration steps, prerequisites, and best practices.

Integration Prerequisites

Before integrating the e-RUPI APIs, ensure the following prerequisites are configured to enable a secure and seamless integration.

API Base URLs

Use the appropriate base URL depending on your deployment environment.

Productionhttps://erupi.vistar.solutions/v2

UAT / Staginghttps://uat.vistar.solutions/v2

Endpoints differ for Generator and Vendor partners. Use the appropriate endpoint paths based on your partner type.

Required Headers

All API requests must include the following headers for authentication and request tracking.

X-API-KEYUnique key assigned to authenticate requests.requiredstring
X-API-SECRETSecret token for secure server-to-server communication.requiredstring
X-PARTNER-IDIdentifier provided to partner for request tracking.requiredstring

Ensure all headers are included in every request. Regenerating X-API-SECRET will immediately invalidate the previous secret.

IP Whitelisting

For enhanced security, API requests are accepted only from whitelisted IP addresses. You can manage your server IPs directly from the e-RUPI Partner Portal. Requests originating from non-whitelisted IPs will be blocked automatically.

Obtain API Credentials

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

Sample API Requests

Example cURL requests demonstrating authenticated API calls. Replace {{base_url}} and {{endpoint}} as per your environment and partner type.

POST Request

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 Request

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 integration, contact at help@meribachat.in.

Loading dashboard…