Direct Bank Request API

Checksum required: No

Use Case

When JSON request is made to processTransaction API, and merchant has preference nativeOtpSupported, we return APIs for direct bank page which can be used by merchant on its own bank page.

Request Attributes

API Content format: JSON

Body

ATTRIBUTEDESCRIPTIONMANDATORY
otpbank otp (only when request type is submit)Conditional
requestTypesubmit/cancel/resendYes
txnTokentxnToken received in Initiate txnYes

Response Attributes

Head

ATTRIBUTEDESCRIPTIONMANDATORY
response timestamp Stringresponse timestampYes
version Stringversion of APINo

Body

ATTRIBUTEDESCRIPTIONMANDATORY
resultInfo ResultInfoResult Info of API callYes
txnInfo Map<String,String>Map of txnInfoNo
callBackUrl StringcallBackUrl of MerchantNo
deepLinkInfo Map<String,String>Deeplink for UPI intentNo
bankForm ObjectBankFormNo

ResultInfo

ATTRIBUTEDESCRIPTIONMANDATORY
resultStatus enumStatus of API call
(S:Success, F:Faliure, U:Unknown)
Yes
resultCode StringResult code returned to merchant . Max length of result code can be 64Yes
resultMsg String(256)Result Message contains information about the result.Yes
isRedirect booleanTo direct from pageNo
bankRetry booleanwhen otp entered is incorrect and banks want retryNo
retry booleanFlag indicating if retry of payment is allowed on the transaction in case of payment failuresNo

Response Codes and messages

resultCoderesultStatusresultMsg
0000SSuccess
0001FFail

Endpoints

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

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

Request CodeResponse JSON
 curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/directBankRequest?mid=AliOPG01851465523919&orderId=ORDER_1556286794' --header 'Content-Type: application/json' --data '{"txnToken":"3f8801563bfc4fe6bec3bb94ebb712df1556286795117","requestType":"submit","otp":"958298"}'