• 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 NB Payment Channel API

      Use Case


      This API returns list of Net Banking instruments with their success rate and icons , configured for given MID along with user addAndPay payment instruments if SSO Token or Txn Token is present in session.

      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
      type string
      mandatory
      Channel list as per transaction flow
      Possible Values: MERCHANTFor Default Flow, ADD_MONEYFor Add and Pay Flow

      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
      nbPayOption object
      Net Banking Pay option
      PayMethod +
      AttributeDescription
      displayName string(Net Banking)
      Name displayed for mode of payment.
      Possible Values: Net Banking
      isDisabled object
      Payment Mode Status
      StatusInfo +
      AttributeDescription
      status string
      Status of Payment Channel
      Possible Values: true, false
      msg string
      Message contains info about status
      payChannelOptions array of object
      List of available Payment Mode Channels
      PayChannelBase +
      AttributeDescription
      isDisabled object
      Channel Status
      StatusInfo +
      AttributeDescription
      status string
      Status of Payment Channel
      Possible Values: true, false
      msg string
      Message contains info about status
      hasLowSuccess object
      Channel success rate
      StatusInfo +
      AttributeDescription
      status string
      Status of success rate
      Possible Values: true, false
      msg string
      Message contains info about status
      iconUrl string(255)
      Icon Url of the channel
      isHybridDisabled boolean
      Indicates whether hybird payment is allowed or not for this payChannel
      channelCode string
      PayChannel's short code
      Example: ANDB
      channelName string
      PayChannel's name
      Example: Andhra Bank
      paymentMode string
      Payment mode code
      Possible Values: NET_BANKING
      feeAmount string
      Post Convenience fee
      taxAmount string
      Any tax amount present in PCF
      totalTransactionAmount string
      total amount in case merchant is a PCF merchant and PCF is applicable
      priority string
      Signifies order of display
      Example: 1
      isHybridDisabled boolean
      Whether hybrid payment mode is enabled or not for this paymethod
      onboarding boolean
      Used for Postpaid onboarding
      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/theia/api/v1/fetchNBPaymentChannels?mid={mid}&orderId=ORDERID_98765' \
      --header 'Content-Type: application/json' \
      --data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"type":"MERCHANT"}}'