Direct Bank Request API

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

PARAMETERDESCRIPTIONMANDATORY
otpbank otpOnly for submit
requestTypesubmit/cancel/resendYes
txnTokentxnToken received in Initiate txnYes

Response Attributes:

API Content format: JSON

Head

PARAMETERDESCRIPTIONMANDATORY
response timestamp Stringresponse timestampYes
version Stringversion of APIYes

Body

PARAMETERDESCRIPTIONMANDATORY
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

PARAMETERDESCRIPTIONMANDATORY
resultStatus enum (S(Success), F(Failure), U(Unknown))Status of API callYes
resultCode stringResult code returned to merchant . Max length of result code can be 64Yes
resultMsg string (Max length can be 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

CODESTATUS
0000Success
0001Fail

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