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

      Update Transaction API

      Checksum required: Yes

      Use Case


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

      Request Attributes

      API Content format: JSON

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      txnToken stringUnique Transaction Token generated in initiateTransactionCall to PG. Merchant has to send back the same transaction token everytime in each subsequent API Call to communicate with PG.Yes
      version stringVersion of the API. Current version is v1.No
      channelId enum (APP, WEB, WAP, SYSTEM)Channel through which call is initiated.Yes
      requestTimestamp stringUNIX timestamp of the time request is being sent.No
      clientId stringClientId by which key checksum is created, required to validate the checksum. Eg C11.No
      signature stringChecksum string created by using paytm checksum llibrary.Yes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      txnAmount MoneyTransaction amount and the currency type.No
      goods List<GoodsInfo>This contain the goods info for an order.No
      shippingInfo List<ShippingInfo>This contain the shipping info for an order.No
      extendInfo ExtendInfoMerchant can pass any order specific information that is required to be passed here.No

      Money

      ATTRIBUTEDESCRIPTIONMANDATORY
      currency enum (INR)currencyYes
      value string (regexp = [0-9]+([.][0-9]{1, 2})?, length less than 16 characters)txn amount.Yes

      ExtendInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      udf1 stringUser define parameter 1No
      udf2 stringUser define parameter 2No
      udf3 stringUser define parameter 3No
      mercUnqRef stringUser define parameter 4No
      comments stringCommentsNo
      amountToBeRefunded stringflag used in case of subscription flow to set refunded amountNo

      GoodsInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      merchantGoodsId stringUnique id for the goods item (item No).Yes
      merchantShippingId stringShipping IdNo
      snapshotUrl stringProduct Image URLNo
      description stringDescription of productYes
      category stringCategory of ProductYes
      quantity stringQuantity orderedYes
      unit stringUnit of quantity (KG/Liter)No
      price MoneyPrice of productYes
      extendInfo ExtendInfoMerchant can pass any order specific information that is required to be passed.No

      ShippingInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      merchantShippingId stringMerchant shipping idYes
      trackingNo stringTracking number of shipmentNo
      carrier stringShipping carrier nameNo
      chargeAmount MoneyShipping amountNo
      countryName stringShipping country nameYes
      stateName stringShipping stateYes
      cityName stringShipping cityYes
      address1 stringShipping address 1Yes
      address2 stringShipping address 2No
      firstName stringReceiver first nameYes
      lastName stringReceiver last nameYes
      mobileNo stringReceiver mobile NoNo
      zipCode stringReceiver zip codeYes
      email stringReceiver emailNo

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      responseTimestamp stringTimestamp at which response was sent.Yes
      version stringVersion of the API passed in the request.No
      clientId stringClientId by which key checksum is created, required to validate the checksum. Eg C11.No
      signature stringChecksum string created by using paytm checksum llibrary.Yes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultInfo ResultInfoResult Info of API call.Yes
      extraParamsMap Map<String, Object>Map for any Extra information.No

      ResultInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultCodeStringResult code returned to merchant . Max length of result code can be 64.Yes
      resultStatusString
      (S:Success, F:Failure, U:Unknown)
      Status of API call.Yes
      resultMsgString (256)Result Message contains information about the result.Yes

      Response Codes and Messages

      resultCoderesultStatusresultMsg
      0000SSuccess operation
      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

      Endpoints

      Staging: https://securegw-stage.paytm.in/theia/api/v1/updateTransactionDetail?mid={mid}&orderId={order-id}

      Production: https://securegw.paytm.in/theia/api/v1/updateTransactionDetail?mid={mid}&orderId={order-id}

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/updateTransactionDetail?mid={mid}&orderId={order-id}' --header 'Content-Type: application/json' --data '{"body":{"txnAmount":{"value":"{transaction-amount-value}","currency":"{transaction-amount-currency}"},"userInfo":{"custId":"{customer-id}"}},"head":{"txnToken":"{transaction-token}","signature":"{signature}"}}'