Pre Validation

Validate UPI

validateUPI

This method is used to validate the UPI VPA ID for India. This method can be used before calling Send Remittance to ensure the UPI VPA ID is valid.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Send Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
vpaId	String	100	Yes	UPI VPA ID to be validated. E.g.: ABCDEF@ABC

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
isValidUPIVPAID	String	Returns "Yes" if the UPI VPA ID is valid, "No" if not valid.
vpaId	String
Name	String	Account holder's name. This will only be returned if isValidUPIVPAID = "Yes"

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:validateUPI>
         <vpaId>jerincj@sib</vpaId>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:validateUPI>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:validateUPIResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:isValidUPIVPAID>Yes</ns2:isValidUPIVPAID>
            <ns2:vpaId>jerincj@sib</ns2:vpaId>
            <ns2:name>JERIN C J</ns2:name>
         </return>
      </ns3:validateUPIResponse>
   </S:Body>
</S:Envelope>