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

      Fetch All Offers API

      Checksum required: Yes

      Use Case


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

      Request Attributes

      API Content format: Application/JSON


      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      requestIdStringUnique reference ID for a transaction which is generated by merchant.No
      requestTimestampStringUNIX timestamp of the time request is being sent.No
      channelIdStringChannel through which call is initiated.
      For websites, the value is WEB.
      For Mobile websites/App, the value is WAP.
      Yes
      versionStringVersion of the API. Current version is v1.No
      tokenTypeStringThis is for authentication method.
      For SSO token authentication, the value is SSO.
      For checksum authentication, the value is CHECKSUM.
      Yes
      tokenStringIn case of tokenType SSO Inputs could be : SSO token value.
      In case of tokenType CHECKSUM Inputs could be : CHECKSUM value.
      Yes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      mid StringThis is a unique identifier provided to every merchant by Paytm.Yes

      Response Attributes


      Head

      ATTRIBUTEDESCRIPTION
      requestId StringUnique reference ID for a transaction which is generated by merchant sent in request.
      responseTimestamp StringUNIX Timestamp of the response.
      version StringVersion of the API passed in the request.

      Body

      ATTRIBUTEDESCRIPTION
      paymentOffers Payment OffersPayment offers contains promo details like promocode, offer, termsUrl etc.
      resultInfo ResultInfoInformation related to response of the request.

      Payment Offer

      ATTRIBUTEDESCRIPTION
      promocode StringThis is unique code for discount.
      offer OfferOffers available.
      termsUrl StringURL to fetch details terms and condition.
      termsTitle StringTerms & condition for applying promo.
      validFrom StringRequest timestamp in milliseconds.
      validUpto StringRequest timestamp in milliseconds.
      isPromoVisible Enum StringTo handle flash sale.

      Offer

      ATTRIBUTEDESCRIPTION
      titleStringName of the promode for display.
      textStringDescription of the promocode.
      iconStringImage of the icon.

      ResultInfo

      ATTRIBUTEDESCRIPTION
      resultCode String (5)Result code returned to merchant.
      resultCodeId String (5)Result code id returned to merchant.
      resultStatus String (10)Status of API call (Success/Failure)
      (S:Success, F:Failure, U:Unknown)
      resultMsg String (256)Result Message contains information about the result.

      Response codes and Messages

      resultCoderesultStatusresultMsg
      00000000SSuccess
      1001FRequest parameters are not valid.
      9999FSomething went wrong.
      2005FChecksum provided is invalid.

      Endpoints

      Staging: https://securegw-stage.paytm.in/theia/api/v1/fetchAllPaymentOffers?mid={mid}

      Production: https://securegw.paytm.in/theia/api/v1/fetchAllPaymentOffers?mid={mid}

      Request CodeResponse JSON
      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}"}}'