• Callback Response
  • Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Paytm Payouts
      API References
      Refunds
      Guides
      Other links
      Mini Apps Platform
  • Features for Investments PG
  • post Banks API - EMI Subvention

    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 Type: JSON

    Head1

    Head

    ATTRIBUTEDESCRIPTION
    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"
    requestId string(32)
    mandatory
    Unique reference ID for a transaction which is generated by merchant and sent in the request
    requestTimestamp string(15)
    mandatory
    EPOCH timestamp of the time at which request is being sent.
    version string(4)
    mandatory
    Version of the API.
    Example: v1
    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
    For tokenType SSO, use SSO Token of Paytm User.
    For tokenType CHECKSUM, It's value to be sent should be the checksum string created by using Paytm checksum library.
    Note: Create the checksum using the body parameter of the request.
    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
    items items
    mandatory
    Item list sent for EMI
    Items +
    AttributeDescription
    id string
    mandatory
    Any 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.
    productId string
    mandatory
    Unique product identifier for the merchant.
    brandId string
    optional
    Product brand identifier for the merchant e.g. LG, Sony etc. Should be send in the request if EMI plans are configured with brand attribute.
    categoryList string[]
    mandatory
    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.
    model string
    optional
    Model id of the product. This should be sent if the merchant's EMI plans are configured with model attribute.
    ean string
    optional
    (Bar code Number) of product. This should be sent if the merchant's EMI plans are configured with EAN attribute.
    price double
    mandatory
    Cumulative price of the product (multiplied by quantity)
    quantity int
    mandatory
    Quantity of the product.
    verticalId string
    mandatory
    Merchant need to send this field with value "PAYTM_EMI"
    isEmiEnabled boolean
    mandatory
    Whether EMI is Enabled for the product.

    Response Attributes


    API Content Type: JSON

    Head2

    Head

    ATTRIBUTEDESCRIPTION
    requestId string(32)
    Unique reference ID for a transaction which is generated by merchant and sent in the request
    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
    resultStatus string
    This parameter indicates the status of API call.
    Possible Values: SFor Success, FFor Failed
    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
    emiTypes items
    List of banks grouped by Emi Types. Any bank providing both subvention and standard EMI plans will be shown in subvention group.
    EmiTypes +
    AttributeDescription
    type enum
    Type of EMI (Subvention or Standard)
    label string
    Label 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 object
    Information about the type of card on which EMI is enabled on list of Items
    CardTypes +
    AttributeDescription
    cardLabel string
    Label assigned to the card.
    cardType string
    Type of Card(CREDIT_CARD or DEBIT_CARD)
    bankDetails object
    Bank details including bank name and bank logo.
    BankDetails +
    AttributeDescription
    bankName string
    Name of the bank to which card belongs.
    bankCode string
    Bank code of the card (ICICI,SBI...)
    bankLogoUrl string
    URL of the bank logo

    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
    StagingProduction
    REQUESTRESPONSE
    curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/emiSubvention/banks?mid={mid}' \
    --header 'Content-Type: application/json' \
    --data '{"body":{"items":[{"id":"ITEMID_98765","productId":"PRODUCTID_98765","brandId":"BRANDID_98765","categoryList":["Electronics"],"quantity":"1","price":"1000","verticalId":"PAYTM_EMI","isEmiEnabled":true}],"mid":"{mid}"},"head":{"requestId":"REQUESTID_98765","token":"{CHECKSUM}","tokenType":"CHECKSUM"}}'