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

      Banks API - EMI Subvention

      Checksum required: Yes

      Use Case


      Purpose of this API is to provide the list of banks, grouped by EMI-type (standard/subvention) available for EMI.

      Request Attributes

      API Content format: JSON

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      channelId StringChannel through which call is initiated.
      For websites, the value is WEB.
      For Mobile websites/App, the value is WAP.
      No
      requestId StringUnique reference ID for a transaction which is generated by merchant.Yes
      requestTimestamp StringUNIX timestamp of the time request is being sentYes
      token StringThe token received from Paytm for that userYes
      tokenTypeStringThis is for authentication method.
      For SSO token authentication, the value is SSO.
      For checksum authentication, the value is CHECKSUM.
      Yes
      version StringVersion of the API. Current version is v1.Yes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      items Item[ ]Item list sent for EMIYes
      mid StringThis is a unique identifier provided to every merchant by Paytm.Yes

      Items

      AttributeDescriptionMandatory
      id StringAny unique identifier for one item in the request e.g. in case of 2 items in the cart, the values can be sent as 1234 and 1236.Yes
      productId StringUnique product identifier for the merchant.Yes
      brandId StringProduct brand identifier for the merchant e.g. LG, Sony etc. Should be send in the request if EMI plans are configured with brand attribute.No
      categoryList String[ ]Product category identifiers for the merchant (categories can be Electronics, footwears etc). This should be sent in the request with same value which is configured in the EMI plan.Yes
      model StringModel id of the product. This should be sent if the merchant's EMI plans are configured with model attribute.No
      ean String(Bar code Number) of product. This should be sent if the merchant's EMI plans are configured with EAN attribute.No
      price DoubleCumulative price of the product (multiplied by quantity)Yes
      quantity IntQuantity of the product.Yes
      verticalId StringMerchant need to send this field with value "PAYTM_EMI"Yes
      isEmiEnabled BooleanWhether EMI is Enabled for the product.Yes

      Response Attributes

      Head

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

      Body

      AttributeDescritpion
      emiTypes BankDetailsByEmiType[ ]List of banks grouped by Emi Types. Any bank providing both subvention and standard EMI plans will be shown in subvention group.
      resultInfo resultInfo Information about result of the API

      EmiTypes

      AttributeDescription
      type EnumType of EMI (Subvention or Standard)
      label StringLabel of EMI. This response field explains whether EMI type provided by bank is Zero/Low cost or Standard EMI.
      info String [ ]Info about EMI.
      cardTypes cardType[ ]Information about the type of card on which EMI is enabled on list of Items

      CardTypes

      AttributeDescription
      cardLabel StringLabel assigned to the card.
      cardType StringType of Card(CREDIT_CARD or DEBIT_CARD)
      bankDetails BankDetail[ ]Bank details including bank name and bank logo.

      BankDetails

      AttributeDescription
      bankName StringName of the bank to which card belongs.
      bankCode StringBank code of the card (ICICI,SBI...)
      bankLogoUrl StringURL of the bank logo

      ResultInfo

      AttributesDescription
      resultStatus StringStatus of Result("S" or "F")
      resultMsg StringMessage of Result
      resultCode StringCode of the Result

      Response Codes and Messages

      resultCoderesultStatusresultMsg
      0000SSuccess
      0001FFAILED
      1001FRequest prameters are not valid
      1007FMissing mandatory element
      2006FMID is invalid
      EMI_001FMandatory info is missing
      EMI_002FItems's data is not valid
      EMI_003FItems are empty
      EMI_004FSome error occured. Please try later
      EMI_005FPlans not available right now. Please try later
      EMI_006FNo emi options are available for these items
      EMI_007FInvalid bank details
      EMI_008FYou are not eligible for availing EMI on this card
      EMI_009FSelected plan does not exist
      EMI_010FSelected plan is not eligible for these items
      EMI_011FSelected plan details might have changed
      EMI_012FLock is acquired, please try after some time
      EMI_013FCards details are invalid
      EMI_014FNo subvented items found to be stamped
      EMI_015FOrder data could not be stamped. Please try again
      EMI_016FOrder item status could not be updated. Please try again
      EMI_017FMore than 2 retries are not allowed
      EMI_018FEMI is not enabled on some items
      EMI_019FSome of the selected offers are invalid
      EMI_020FSelected plan is not offered by this bank

      Endpoints

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

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

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/emiSubvention/banks?mid={mid}' --header 'Content-Type: application/json' --data '{"body":{"items":[{"id":"{id}","productId":"{product-id}","brandId":"{brand-id}","categoryList":["{categories}"],"quantity":"{number-of-quantity}","price":"{total-price}","verticalId":"PAYTM_EMI","isEmiEnabled":true}],"mid":"{mid}"},"head":{"requestId":"{request-id}","token":"{CHECKSUM}","tokenType":"CHECKSUM"}}'