Skip to main content

Validate UPI VPA [v3]‚Äč

This API can be used to validate the UPI ID or VPA (Virtual Payment Address). This should be validated before placing a collect UPI request as invalid UPI IDs will fail. The API will return the validity of the UPI ID shared and also provide the Account Holder Name of the valid UPI ID.

Request Body required
    upi_id string required

    Possible values: Value must match regular expression [a-zA-Z0-9.\-_]{2,256}@[a-zA-Z]{2,64}

    This is the UPI ID of the customer that needs to be validated

Responses

When the UPI ID has been validated, the response will be as below


Schema
    oneOf

    status string

    Possible values: [SUCCESS]

    This value will be returned as SUCCESS

    vpa string

    This is the UPI ID shared in the request

    isVPAValid integer

    Possible values: [1]

    The valid UPI ID will return a value of 1

    payerAccountName string

    The name of the account holder who has this UPI ID

Loading...