Overview

This API facilitates the retrieval of the name and Virtual Payment Address (VPA or UPI ID) associated with a given mobile number.

UPI (Unified Payments Interface) is a real-time payment system widely used in India, enabling users to link multiple bank accounts to a single mobile application. Through UPI, individuals can seamlessly perform various transactions, including peer-to-peer transfers, bill payments, and online purchases.

API Endpoint

The API endpoint is specified in the request, and users are required to include relevant authentication headers such as client_id, client_secret, and module_secret.

These credentials ensure the security and authorization of the API call.

Request Parameters

The API request requires several essential parameters.

The reference_id serves as a unique identifier for the transaction, aiding in tracking and reconciliation.

User consent is captured through the consent parameter, while the purpose field allows businesses to specify the reason for fetching VPA, promoting transparency. Also, the purpose should be a minimum of 20 characters.

The mobile parameter contains the user's mobile number that needs to be verified.

👍

Good to know

1. It is essential to provide a valid mobile number as input for accurate results.
2. In cases where the provided mobile number is associated with multiple VPAs, the API returns details of one VPA.
3. The API ensures robust error handling, providing appropriate responses for invalid inputs or no matching records.

Sample Request Body

{
    "reference_id": "XXXXXXXX",
    "consent": true,
    "purpose": "To verify user VPA/ Name",
    "mobile": "XXXXXX"
}

Request Mapping Table

Sample Response Body

{
    "decentroTxnId": "XXXXX",
    "status": "SUCCESS",
    "responseCode": "S00000",
    "message": "VPA fetched successfully",
    "data": {
        "name": "XXX",
        "upi": true/false,
        "vpa": "XXXX"
    },
    "responseKey": "success_vpa_found"
}

Response Mapping Table

Data Fields Response Mapping