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

      post Validate VPA API

      Checksum required: No

      Use Case


      To validate user VPA address in case UPI collect flow.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      version String(4)Version of the API. Current version is v1. No
      channelId String(3)Channel through which API call is initiated.
      For websites, the value to be passed should be "WEB" and for Mobile websites/App, the value to be passed should be "WAP"
      This parameter is used to control the theme of the payment page. Based on the channel passed, Paytm will render the layout suitable for that specific platform.
      No
      requestTimestamp String(15)EPOCH timestamp of the time at which request is being sent. No
      txnToken String(64)This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes. Yes
      Body1

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      vpa StringUser VPA address. Yes

      Response Attributes


      API Content Type: JSON

      Head2

      Head

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

      Body

      ATTRIBUTEDESCRIPTION
      resultInfo ObjectThis parameter gives the information about the result of the API response
      ResultInfo +
      AttributeDescription
      resultCode StringThis 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 StringThis parameter indicates the status of API call. It's possible values are:
      1. S - Success
      2. F - Failure
      3. U - Unknown
      resultMsg String(256)This parameter is the result message which contains information about the result.
      vpa StringUser VPA address.

      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={order-id}' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"vpa":"{vpa}"},"head":{"txnToken": "{transaction-token}"}}'