search

POSTFetch NB Channel API

Use Case

This API returns a list of Net Banking instruments with their icons , configured for a given MID. 

 Note

  • TxnToken URL (Mentioned as endpoints under the top-right section of this document)
  • AccessToken URL:
    • Staging URL
      • https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchNBChannels?mid={{mid}}&referenceId={{referenceId}}
    • Prod URL
      •  https://router.paytm.in/aoa-pay-option-service/v2/fetchNBChannels?mid={{mid}}&referenceId={{referenceId}}

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimestamp
string
optional

Request time in mili-seconds.
 

Example: 1588402269

token
string
mandatory

This is the unique transaction token
 

Example: ede0b9a1-e30d-4fa0-89fb-68221c3e9ff6

tokenType
TokenType
mandatory

Token Type, Values that can be selected: TXN_TOKEN, ACCESS

channelId
EchannelId
optional

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

Possible values: WEB, WAP

Body

AttributeDescription
type
NBTxnType
mandatory

Channel list as per the transaction flow
enum: MERCHANT, ADD_MONEY
 

mid
string
mandatory

Paytm provides MID as a unique identifier for each merchant.

orderId
string
optional

The Unique reference ID of the Order. It is alphanumeric and the max length is 50 characters.
 

Example: AOA001115. (Mandatory in case of TXN_TOKEN)

referenceId
string
optional

This is the unique reference id.
 

Example: AOA1011AOA1012 (Mandatory in case of ACCESS_TOKEN)

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

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

Body

AttributeDescription
resultInfo
ResultInfo

Result Info of API call

ResultInfo
+
AttributeDescription
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

nbPayOption
string

NB pay option

PaymentMethod
+
AttributeDescription
displayName
string

Payment mode name

 

Possible Values: Paytm Balance, Paytm Payments Bank, Bhim UPI, Credit Card, Debit Card, Net Banking, EMI

payChannelOptions
List <PayChannelOption>

Payment mode channel List

PayChannelOption
+
AttributeDescription
iconUrl
string

Payment channel icon

bankLogoUrl
string

Issuing Bank logo icon

channelCode
string

Issuing bank code

channelName
string

Name of channel Code.

minAmount
string

The minimum amount needed for the planId. (In case of EMI Only)

Amount
+
AttributeDescription
value
string

This parameter contains the amount to be charged to the customer and can have two places of decimal.

 

Example: 1.00

currency
string

This parameter indicates the currency in which transaction amount is to be deducted.
 

Possible Values: INR

maxAmount
string

The maximum amount needed for the planId. (In case of EMI Only)

Amount
+
AttributeDescription
value
string

This parameter contains the amount to be charged to the customer and can have two places of decimal.

 

Example: 1.00

currency
string

This parameter indicates the currency in which transaction amount is to be deducted.
 

Possible Values: INR

cardType
string

Type of card. (In case of EMI Only)

 

Possible Values: CREDIT_CARD, DEBIT_CARD

channelDisplayName
string

Display name of channel code. (In case of EMI Only)

balanceInfo
string

Basic details of Paytm wallet. (In case of Wallet, PPBL, Postpaid Only)

AccountBalanceInfo
+
AttributeDescription
accountBalance
string

Total balance, in case of Wallet, PPBL, Postpaid.

BalanceInfo
+
AttributeDescription
subWalletDetails
array of object

Basic details of Paytm sub wallet

SubWalletDetails
+
AttributeDescription
displayName
string

Paytm sub wallet name

Example: Paytm Wallet

balance
string

Paytm sub wallet balance

Example: 2.00

imageUrl
string

Paytm sub wallet icon

payerAccountExists
boolean

Status of Paytm Wallet

accountBalance
object

Total balance of Paytm wallet

Money
+
AttributeDescription
value
string

This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00

currency
string

This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR

status
string

This flag indicates the status of this payment mode. (In case of Wallet, PPBL, Postpaid Only)

AccountStatusInfo
+
AttributeDescription
isDisabled
string

Payment channel status

msg
string

Disable status message

userAccountExists
string

Status of user account.

 

Possible Values: true/false

merchantAccepts
string

Status of merchant accepts this pay mode.

 

Possible Values: true/false

priority
string

Signifies order of display

prepaidCardSupported
boolean

Indicates if prepaid card is configured on the merchant

paymentMode
PayMethod

Mode of payment

 

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NTE_BANKING, EMI

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
1007FMissing mandatory element
1006FYour Session has expired
1001FRequest parameters are not valid Note: If the value is not valid in the request parameter then the result message should be in the format of "Invalid {field name}" For example:Invalid tokenType, etc
2014FReferenceId in the query param doesn't match with the ReferenceId send in the request
2014FOrderId in the query param doesn't match with the OrderId send in the request
501FSystem Error
2006FMid is invalid
2006FReference Id is invalid
2013FMid in the query param doesn't match with the Mid send in the request
2222FInvalid request body
1011FParameter illegal Note: If the value is not allowed in request parameters then the result message should be in the format of "Invalid {field name}" For example:Invalid tokenType, etc
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchNBChannels?mid={{mid}}&orderId={{orderId}}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location --request POST 'https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchNBChannels?mid=YOUR_MID_HERE&orderId=shub324' \
--header 'Content-Type: application/json' \
--data-raw '{"head": {"channelId": "WEB","token": "null","tokenType": "TXN_TOKEN"},"body": {"mid": "YOUR_MID_HERE","referenceId" : "shub2721shub2720","orderId": "shub324","type" : "MERCHANT"}}'

 

copy icon