• 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 Update Transaction API

      Use Case


      This API updates txnAmount , goods , shippingInfo , extendInfo in order details in Native flow.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      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
      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
      clientId string(3)
      optional
      Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
      Example: C11
      signature string(108)
      mandatory
      Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      txnAmount object
      mandatory
      This parameter is an object and should contain the value of transaction i.e. amount and currency type
      Example: {"value" : "1.00", "currency" : "INR"}
      TxnAmount +
      AttributeDescription
      value string
      mandatory
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string(INR)
      mandatory
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      goods array of object
      optional
      This contain the goods info for an order.
      GoodsInfo +
      AttributeDescription
      merchantGoodsId string
      optional
      Unique id for the goods item (item no)
      merchantShippingId string
      optional
      Shipping Id
      snapshotUrl string
      optional
      Product Image URL
      description string
      mandatory
      Description of product
      category string
      optional
      Category of Product
      quantity string
      mandatory
      Quantity ordered
      unit string
      optional
      Unit of quantity (KG/Litre)
      price object
      mandatory
      Price of product
      Money +
      AttributeDescription
      value string
      mandatory
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      mandatory
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      extendInfo object
      optional
      Extended info of goods
      ExtendInfo +
      AttributeDescription
      udf1 string(64)
      optional
      User define parameter 1
      udf2 string(64)
      optional
      User define parameter 2
      udf3 string(64)
      optional
      User define parameter 3
      mercUnqRef string(64)
      optional
      Merchant's reference text which comes in final response of Process Transaction API from Paytm
      comments string(256)
      optional
      Comments
      shippingInfo array of object
      optional
      This contain the shipping info for an order.
      ShippingInfo +
      AttributeDescription
      merchantShippingId string
      optional
      Merchant shipping id
      trackingNo string
      optional
      Tracking no of shipment
      carrier string
      optional
      Shipping carrier name
      chargeAmount object
      mandatory
      Shipping amount
      Money +
      AttributeDescription
      value string
      mandatory
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1.00
      currency string
      mandatory
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      countryName string
      optional
      Shipping country name
      stateName string
      optional
      Shipping state name
      cityName string
      optional
      Shipping city name
      address1 string
      optional
      Shipping address 1
      address2 string
      optional
      Shipping address 2
      firstName string
      optional
      Receiver first name
      lastName string
      optional
      Receiver last name
      mobileNo string
      optional
      Receiver mobile no
      zipCode string
      optional
      Receiver zip code
      email string
      optional
      Receiver email
      extendInfo object
      optional
      Merchant can pass any order specific information that is required to be passed here.
      ExtendInfo +
      AttributeDescription
      udf1 string(64)
      optional
      User define parameter 1
      udf2 string(64)
      optional
      User define parameter 2
      udf3 string(64)
      optional
      User define parameter 3
      mercUnqRef string(64)
      optional
      Merchant's reference text which comes in final response of Process Transaction API from Paytm
      comments string(256)
      optional
      Comments

      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
      clientId string(3)
      Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
      Example: C11
      signature string(108)
      You should validate the parameter values by verifying the signature comes in the response. It ensures that parameter values not tempered. Signature string can be verified by using Paytm checksum library
      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
      isRedirect boolean
      This flag indicates that number of retries are over and user is to be redirected from cashier page
      bankRetry boolean
      This flag indicates that retry is allowed at bank's end or not
      retry boolean
      This flag indicates whether retry is allowed or not
      extraParamsMap object
      Map for any extra information.

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      0000SSuccess
      1006FtxnToken sent in request has expired or is invalid
      2013FDifferent mids sent in initiate transaction request and updateTransactionRequest
      2014FDifferent orderIds sent in initiate transaction request and updateTransactionRequest
      0000900USystem error
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/updateTransactionDetail?mid={mid}&orderId=ORDERID_98765' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"txnAmount":{"value":"1.00","currency":"INR"},"userInfo":{"custId":"CUST_001"}},"head":{"txnToken":"2f61025f332b444197d8b9d1e509c07e1589794795189","signature":"{signature}"}}'