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
Head
| Attribute | Description |
|---|---|
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
| Attribute | Description |
|---|---|
type NBTxnType mandatory | Channel list as per the transaction flow |
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
Head
| Attribute | Description |
|---|---|
responseTimestamp string | EPOCH timestamp of the time at which response is being sent. |
Body
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resultInfo ResultInfo | Result Info of API call | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResultInfo +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nbPayOption string | NB pay option | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentMethod +
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Codes & Messages
| resultCode | resultStatus | resultMsg |
|---|---|---|
| 0000 | S | Success |
| 1007 | F | Missing mandatory element |
| 1006 | F | Your Session has expired |
| 1001 | F | Request 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 |
| 2014 | F | ReferenceId in the query param doesn't match with the ReferenceId send in the request |
| 2014 | F | OrderId in the query param doesn't match with the OrderId send in the request |
| 501 | F | System Error |
| 2006 | F | Mid is invalid |
| 2006 | F | Reference Id is invalid |
| 2013 | F | Mid in the query param doesn't match with the Mid send in the request |
| 2222 | F | Invalid request body |
| 1011 | F | Parameter 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 |
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"}}'
