API Reference

Register UPI Mandate API

This API is used to register a UPI mandate for a given loan, enabling automated payments through UPI.

Endpoint:

POST /api/v1/client/loan/{loan_id}/register-upi-mandate/

Sample payload is given below:

  "enach_type": "upi",
  "return_url": "https://portal.autovertplug.com/"
  • enach_type (string): The type of eNACH (Electronic National Automated Clearing House) mandate to be registered. For UPI mandates, this value should be "upi".
  • return_url (string): A URL where the user will be redirected after completing the mandate registration process.

A successful response indicates that the UPI mandate registration was initiated.

{
    "is_success": true,
    "data": {
        "status": "OK",
        "message": "Subscription created successfully",
        "subReferenceId": 14617101,
        "authLink": "https://cfre.in/CSHFRE/w2eu9yx",
        "subStatus": "INITIALIZED"
    }
}

An error response may include details about what went wrong.

{
    "is_success": false,
    "error": {
        "message": "Invalid credentials.",
        "code": "AuthenticationFailed"
    }
}

Notes

  • Ensure that the Authorization header contains valid base64-encoded credentials.
  • Replace {loan_id} in the URL with the actual loan identifier
  • The return_url must be a valid URL that your application handles for post-registration redirection
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!