search
Your Paytm for business app is working and will keep working beyond March 15th, 2024. Click to know more

POSTFetch 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.

 

Query Params

ATTRIBUTE DESCRIPTION

mid

string
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

orderId

string
conditional

This is the unique identifier for an order and should have same value as used in orderId of Initiate Transaction API or Initiate Subscription API.
Note: It becomes mandatory in case tokenType value is send as CHECKSUM or TXN_TOKEN in this request.
Example: OREDRID_98765

referenceId

string
conditional

This is the unique reference id and should have same value as used in Access Token API.
Note: It becomes mandatory in case tokenType value is send as ACCESS in the request.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

requestTimestamp
string
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

channelId
string
optional

The parameter value identifies the Channel for which API call is initiated.

Possible values:
WEB
For websites, the value to be passed should be "WEB"
,
WAP
For Mobile websites/App, the value to be passed should be "WAP"
tokenType
string
mandatory

Authorization method for this request.

Possible values:
ACCESS
To be used in case authentication is done using access token.
,
TXN_TOKEN
To be used in case authentication done using transaction token.
token
string
mandatory

Authorization string corresponding to the tokenType used.

Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323

Body

AttributeDescription
type
string
mandatory

Channel list as per the transaction flow

Possible values:
MERCHANT
For Default Flow
,
ADD_MONEY
For Add and Pay Flow

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string

Version of the API passed in the request.
Example: v1

responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

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: S, F, U

resultMsg
string

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

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

Icon Url of the channel

isHybridDisabled
string

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 & Messages

resultCoderesultStatusresultMsg
0000SSuccess
1001FRequest parameters are not valid
1006FSession expired
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
Staging
Production
https://securegw-stage.paytm.in/theia/api/v1/fetchNBPaymentChannels?mid={mid}&orderId={order-id}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchNBPaymentChannels?mid={mid}&orderId=ORDERID_98765' \
--header 'Content-Type: application/json' \
--data '{"head":{"tokenType":"TXN_TOKEN","token":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"type":"MERCHANT"}}'
copy icon