e-RUPI Integration GuideVersion 2.0.0

Endpoint Details

This endpoint retrieves the current wallet balance associated with a vendor account. It provides real-time data on the available balances for both commission and generation purposes.

endpoint:
  path: /vendor/fetch-wallet-balance
  method: GET
  headers:
    - name: X-API-KEY
      required: true
      description: API key for authentication.
    - name: X-API-SECRET
      required: true
      description: API secret for authentication.
    - name: X-PARTNER-ID
      required: true
      description: Partner ID for authentication.
  contentType: application/json
  response:
    description: JSON object containing wallet balance.

Endpoint Url:

/vendor/fetch-wallet-balance

Note: Append this path to the appropriate base URL mentioned in the Prerequisites section.

Endpoint Description and Usage:

This endpoint provides an overview of the wallet balance available for an e-RUPI Vendor account. It's especially useful for monitoring fund availability and ensuring smooth voucher generation workflows.

Security

All requests to this endpoint must be authenticated using the required headers as specified in the Prerequisites section. Ensure that your API key and other credentials are kept secure and not exposed in client-side code. Failure to provide valid authentication headers will result in a 401 Unauthorized error.

Sample Request:

Here is an example of a cURL command to fetch wallet balances using this endpoint:

curl -X GET \
  https://{{base_url}}/vendor/fetch-wallet-balance \
  -H "X-API-KEY: your-api-key" \
  -H "X-API-SECRET: your-api-secret" \
  -H "X-PARTNER-ID: your-partner-id"

Success Response

Upon a successful request, the API will return a JSON object with the voucher status:

{
  "status": {
    "code": "200",
    "error": false
  },
  "message": "Wallet balance retrieved successfully",
  "result": {
    "walletBalance": "1500"
  }
}

Error Response

If there is an error with the request, the API will return a JSON object with error details:

{
  "status": {
    "code": "400",
    "error": true
  },
  "message": "Error message describing the issue",
  "result": null
}

Response Schema (YAML)

The response schema for both success and error responses is as follows:

parameters:
  - name: status
    in: body
    description: Contains response metadata.
    required: true
    schema:
      type: object
      properties:
        code:
          type: string
          description: HTTP-style status code.
        error:
          type: boolean
          description: Indicates if the API encountered an error.

  - name: message
    in: body
    description: Human-readable message describing the result or error.
    required: true
    schema:
      type: string

  - name: result
    in: body
    description: Contains details of the result in case of success; will be null in case of an error.
    required: true
    schema:
      type: object
      nullable: true
      properties:	
        walletBalance:
          type: string
          description: Current wallet balance in INR.