• 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 Fetch EMI API

      Use Case


      This API fetch the list of emi details like tenure , interest rates , min and max amount for requested channel configured for given MID

      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
      channelCode string(5)
      mandatory
      Channel Code for which you need to fetch EMI details.
      Possible Values: HDFC, AMEX, ICICI, BAJAJFN, IDBI
      amount object
      optional
      Transaction Amount and the currency value.
      Money +
      AttributeDescription
      value string
      mandatory
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 100
      currency string(INR)
      mandatory
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR

      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
      emiDetail object
      EMI details about channel.
      EmiChannel +
      AttributeDescription
      emiChannelInfos array of object
      List of available EMI Plan Ids.
      EMIChannelInfo +
      AttributeDescription
      planId string
      This is the plan which the bank offers.
      Example: ICICI|3
      interestRate string
      Interest rate of the EMI plan.
      Example: 4.50
      ofMonths string
      This is the months plan of EMI.
      Example: 3.00
      minAmount object
      The minimum amount needed for the planId.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 100
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      maxAmount object
      The maximum amount needed for the planId.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1000000
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      emiAmount object
      This is an additonal amount for EMI.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 33.39
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      totalAmount object
      Total amount with EMI amount added.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 100.17
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      emiHybridChannelInfos array of object
      List of available EMI Plan Ids for Hybrid Transaction.
      EMIChannelInfo +
      AttributeDescription
      planId string
      This is the plan which the bank offers.
      Example: ICICI|3
      interestRate string
      Interest rate of the EMI plan.
      Example: 4.50
      ofMonths string
      This is the months plan of EMI.
      Example: 3.00
      minAmount object
      The minimum amount needed for the planId.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 100
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      maxAmount object
      The maximum amount needed for the planId.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 1000000
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      emiAmount object
      This is an additonal amount for EMI.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 33.39
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      totalAmount object
      Total amount with EMI amount added.
      Money +
      AttributeDescription
      value string
      This parameter contains the amount to be charged to the customer and can have two places of decimal.
      Example: 100.17
      currency string
      This parameter indicates the currency in which transaction amount is to be deducted.
      Possible Values: INR
      emiType string
      Type of EMI
      isHybridDisabled boolean
      Indicates whether hybrid payment is allowed or not for this EMI option
      extraParamsMap object
      Map for any extra information (in case of error).

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      0000SSuccess
      1001FRequest parameters are not valid
      1006FSession Expired Exception
      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/fetchEMIDetail?mid={mid}&orderId=ORDERID_98765' \
      --header 'Content-Type: application/json' \
      --data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"channelCode":"ICICI"}}'