• 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 Fetch All Offers API

      Use Case


      To fetch merchant's all payment instrument based offers with Paytm.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      requestId string
      optional
      Unique reference ID for a transaction which is generated by merchant.
      requestTimestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      Example: 1588402269
      version string(4)
      optional
      Version of the API.
      Example: v1
      channelId string(3)
      mandatory
      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"
      tokenType string
      mandatory
      This is for authentication method.
      For SSO token authentication, the value is SSO.
      For checksum authentication, the value is CHECKSUM.
      token string
      mandatory
      In case of tokenType SSO Inputs could be : SSO token value.
      In case of tokenType CHECKSUM Inputs could be : CHECKSUM value.
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      mid string(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

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      requestId string
      Unique reference ID for a transaction which is generated by merchant.
      responseTimestamp string(15)
      EPOCH timestamp of the time at which response is being sent.
      Example: 1588402269
      version string(2)
      Version of the API passed in the request.
      Example: v1
      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
      resultCodeId string
      Result code id returned to merchant.
      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
      paymentOffers PaymentOffers
      Payment offers contains promo details like promocode, offer, termsUrl etc.
      PaymentOffers +
      AttributeDescription
      promocode string
      This is unique code for discount.
      offer object
      Offers available.
      Offer +
      AttributeDescription
      title string
      Name of the promode for display.
      text string
      Description of the promocode.
      icon string
      Image of the icon.
      termsUrl string
      URL to fetch details terms and condition.
      termsTitle string
      Terms & condition for applying promo.
      validFrom string
      Request timestamp in milliseconds.
      validUpto string
      Request timestamp in milliseconds.
      isPromoVisible enum string
      To handle flash sale.

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      00000000SSuccess
      1001FRequest parameters are not valid.
      9999FSomething went wrong.
      2005FChecksum provided is invalid.
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchAllPaymentOffers?mid={mid}' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"mid":"{mid}"},"head":{"channelId":"WEB","tokenType":"CHECKSUM","token":"{CHECKSUM}"}}'