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

PARAMETERDESCRIPTIONMANDATORY
versionstringApplication version(provided by paytm)Yes
channelId String (WEB(for web server), WAP(for mobile device))Channel through which call initiatedYes
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

PARAMETERDESCRIPTIONMANDATORY
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 ADDNPAY.
By default , it is MERCHANT.
YES

Response Attributes:

API Content format: JSON

Head

PARAMETERDESCRIPTIONMANDATORY
responseTimestamp stringTimestamp at which response was sentYes
version stringApplication versionYes

Body

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

ResultInfo

PARAMETERDESCRIPTIONMANDATORY
resultStatusString (S(Success), F(Failure), U(Unknown))Status of API callYes
resultCodestringResult code returned to merchant . Max length of result code can be 64Yes
resultMsgstring (Max length can be 256])Result Message contains information about the result.Yes

PayMethod

PARAMETERDESCRIPTIONMANDATORY
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

PARAMETERDESCRIPTIONMANDATORY
isDisabled StatusInfo Channel Status ObjectYES
hasLowSuccess StatusInfo Channel Success RateYES
iconUrl stringIcon Url of the channelYES

StatusInfo

PARAMETERDESCRIPTION
status String (true, false)Status of Payment ChannelYES
msg stringMessage contains info about statusNO

Fetch EMI Response Code, Message and description

PARAMETERDESCRIPTIONMANDATORY
1001Request prameters are not validmid and orderId is invalid/null
1006Session Expired ExceptiontxnToken sent in request has expired or is invalid
2013Mid in the query param doesn’t match with the Mid send in the requestDifferent mid's sent in initiate transaction request and fetchNBPaymentChannelRequest
2014OrderId in the query param doesn’t match with the OrderId send in the requestDifferent orderId's sent in initiate transaction request and fetchNBPaymentChannelRequest
00000900System errorSystem error
0000SuccessSuccess

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"}}