• 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

      post Send OTP API

      Use Case


      To send OTP to the customer’s mobile number for login into Paytm ecosystem. This OTP is valid for 2 minutes.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      version string(4)
      optional
      Version of the API.
      Example: v1
      requestTimestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      Example: 1588402269
      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"
      txnToken string(64)
      mandatory
      This is the unique transaction token received in the response of Initiate Transaction API or Initiate Subscription API. It is valid for 15 minutes.
      Example: f0bed899539742309eebd8XXXX7edcf61588842333227
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      mobileNo string
      mandatory
      10 digit user mobile No
      Example: 7777777777

      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, UFor Unknown
      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
      extraParamsMap object
      Map for any extra information (in case of error).

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      01SSuccess
      02FOtp sent to phone
      202FHTTP Response Code other than 200 received in Generate OTP
      431FInvalid Mobile
      433FAccount Blocked
      517FYour account is temporarily blocked. Please contact customer care.
      531FOops ! You have reached OTP limit, please raise a query at paytm.com/care.
      434FPlease try again after sometime.
      827FThere was some issue in processing this request.
      1006FYour Session has expired.
      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.
      00000900USystem error
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/login/sendOtp?mid={mid}&orderId=ORDER_123456' \
      --header 'Content-Type: application/json' \
      --data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"mobileNumber":"7777777777"}}'