• Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Testing
      Refunds
      Guides
      Other Processes
      Mini Program Platform
        Website Integration

      post Validate VPA API

      Use Case


      To validate user VPA address in case UPI collect flow.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      version string(4)
      optional
      Version of the API.
      Example: v1
      channelId string(3)
      optional
      The parameter value identifies the Channel for which API call is initiated.
      Possible Values: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
      requestTimestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      Example: 1588402269
      txnToken string(64)
      mandatory
      This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes.
      Example: f0bed899539742309eebd8XXXX7edcf61588842333227
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      vpa string
      mandatory
      User VPA address.
      Example: 7777777777@paytm

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      version string(2)
      Version of the API passed in the request.
      Example: v1
      responseTimestamp string(15)
      EPOCH timestamp of the time at which response is being sent.
      Example: 1588402269
      Body2

      Body

      ATTRIBUTEDESCRIPTION
      resultInfo object
      This parameter gives the information about the result of the API response
      ResultInfo +
      AttributeDescription
      resultCode string
      This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below
      resultStatus string
      This parameter indicates the status of API call.
      Possible Values: SFor Success, FFor Failure
      resultMsg string(256)
      This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below
      vpa string
      User VPA address.
      Example: 7777777777@paytm
      valid boolean
      Status of VPA
      extraParamsMap object
      Map for any extra information (in case of error).

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      0000SSuccess
      0FSystem Error, invalid param
      00000900FSystem error
      501FSorry! We could not verify the VPA
      1001FRequest prameters are not valid
      1006FYour Session has expired.
      2004FSSO Token is invalid
      2013FMid in the query param doesn't match with the Mid send in the request
      2014FOrderId in the query param doesn't match with the OrderId send in the request
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/vpa/validate?mid={mid}&orderId=ORDERID_98765' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"vpa":"7777777777@paytm"},"head":{"txnToken": "f0bed899539742309eebd8XXXX7edcf61588842333227"}}'