Fetch NB Payment Channel API

Checksum required: No

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

Head

ATTRIBUTEDESCRIPTIONMANDATORY
versionstringApplication version(provided by paytm)No
channelId StringChannel through which call initiated
WEB: Web server, WAP: Mobile device
Yes
requestTimestampStringUNIX timestamp of the time request is being sentNo
txnTokenStringUnique Transaction Token generated in initiateTransactionCall to PG. Merchant has to send back the same transaction token everytime in each subsequent API Call to communicate with PGYes

Body

ATTRIBUTEDESCRIPTIONMANDATORY
type String (MERCHANT, ADD_MONEY)MERCHANT : When NB channels are required for transactions where payment flow is NONE.
ADD_MONEY : When NB channels are required for transactions where payment flow is ADDANDPAY.
By default , it is MERCHANT.
Yes

Response Attributes

Head

ATTRIBUTEDESCRIPTIONMANDATORY
responseTimestamp stringTimestamp at which response was sentYes
version stringApplication versionNo

Body

ATTRIBUTEDESCRIPTIONMANDATORY
resultInfo ResultInfoResult Info of API callYes
nbPayOption PayMethodNet Banking Pay optionNo
extraParamsMap Map<String, Object>Map for any Extra informationNo

PayMethod

ATTRIBUTEDESCRIPTIONMANDATORY
displayNameString (Net Banking)Name displayed for mode of payment like net banking/credit card/debit cardYes
isDisabled StatusInfoPayment Mode Status ObjectYes
payChannelOptions List<PayChannelBase> List of available Payment Mode ChannelsYes
paymentModeString (NET_BANKING)Payment mode codeYes

PayChannelBase

ATTRIBUTEDESCRIPTIONMANDATORY
isDisabled StatusInfo Channel Status ObjectYes
hasLowSuccess StatusInfo Channel Success RateYes
iconUrl stringIcon Url of the channelYes

StatusInfo

ATTRIBUTEDESCRIPTIONMANDATORY
status String (true, false)Status of Payment ChannelYes
msg stringMessage contains info about statusNo

ResultInfo

ATTRIBUTEDESCRIPTIONMANDATORY
resultCodeStringResult code returned to merchant . Max length of result code can be 64Yes
resultStatusStringStatus of API call
(S:Success, F:Faliure, U:Unknown)
Yes
resultMsgString(256)Result Message contains information about the result.Yes

Response Codes and Messages

resultCoderesultStatusresultMsg
0000SSuccess
1001FRequest prameters 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

Endpoints

Staging: https://securegw-stage.paytm.in/theia/api/v1/fetchNBPaymentChannels?mid=<mid>&orderId=<orderId>

Production: https://securegw.paytm.in/theia/api/v1/fetchNBPaymentChannels?mid=<mid>&orderId=<orderId>

Request CodeResponse JSON
curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchNBPaymentChannels?mid=xxxxxxxxxxxxxxxxxxxx&orderId=xxxxxxxxxxxxxxxxxxxx' --header 'Content-Type: application/json' --data '{"head":{"version":"v1","requestTimestamp":xxxxxxxxxx,"channelId":"WEB","txnToken":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},"body":{"type":"MERCHANT"}}