• Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Webhooks
      Testing
      Refunds
      Guides
      Other Processes
      Mini Program Platform
        Website Integration

      post 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 Type: JSON

      Body1

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      otp Stringbank otp (only when request type is submit) Conditional
      requestType String(6)submit/cancel/resend Yes
      txnToken String(64)This is the unique transaction token received in the response of Initiate Transaction API. It is valid for 15 minutes. Yes

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      version String(2)Version of the API passed in the request.
      responseTimestamp String(15)EPOCH timestamp of the time at which response is being sent.
      Body2

      Body

      ATTRIBUTEDESCRIPTION
      resultInfo ObjectThis parameter gives the information about the result of the API response.
      ResultInfo +
      AttributeDescription
      resultCode StringThis 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 StringThis parameter indicates the status of API call. It's possible values are:
      1. S - Success
      2. F - Failure
      3. U - Unknown
      resultMsg String(256)This parameter is the result message which contains information about the result.
      isRedirect BooleanTo direct from page
      bankRetry Booleanwhen otp entered is incorrect and banks want retry
      retry BooleanFlag indicating if retry of payment is allowed on the transaction in case of payment failures
      txnInfo Map<String,String>Map of txnInfo.
      callBackUrl StringOn completion of transaction, Paytm payment gateway will send the response on this URL. This can be dynamic response URL provided by merchant. Sample URL to be sent by merchant is https://merchant.com/callback/
      deepLinkInfo Map<String,String>Deeplink for UPI intent
      bankForm Object BankForm

      Response Codes and Messages


      resultCoderesultStatusresultMsg
      0000SSuccess
      0001FFail
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/directBankRequest?mid={mid}&orderId={order-id}' \
      --header 'Content-Type: application/json;charset=UTF-8' \
      --data '{"txnToken":"{transaction-token}","requestType":"{request-type}","otp":"{otp}"}'