• Callback Response
  • Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Refunds
      Guides
      Other links
      Mini Program Platform
  • Features for Investments PG
  • post Validate VPA API

    Use Case


    To validate user VPA address in case UPI collect flow.

    Query Params

    ATTRIBUTE DESCRIPTION
    midstring (20)
    mandatory
    Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.
    Example: INTEGR7769XXXXXX9383
    orderIdstring
    conditional
    This is the unique identifier for an order and should have same value as used in orderId of Initiate Transaction API or Initiate Subscription API.
    Note: It becomes mandatory in case tokenType value is send as CHECKSUM or TXN_TOKEN in this request.
    Example: ORDERID_98765
    referenceIdstring
    conditional
    This is the unique reference id and should have same value as used in Access Token API.
    Note: It becomes mandatory in case tokenType value is send as ACCESS in the request.

    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
    tokenType string
    mandatory
    Authorization method for this request.
    Possible Values: ACCESSTo be used in case authentication is done using accessToken and this is received in the response of Access Token API, TXN_TOKENTo be used in case authentication is done using txnToken and this is received in the response of Initiate Transaction API or Initiate Subscription API
    token string
    mandatory
    Authorization string corresponding to the tokenType used.
    Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323
    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
    0001FInvalid UPI ID
    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":{"tokenType":"TXN_TOKEN","token":"f0bed899539742309eebd8XXXX7edcf61588842333227"}}'