• 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

      Add money to your customer’s Paytm Wallet with Paytm Payment Gateway

      Overview of Add Money


      If a customer does not have enough balance for an order/ transaction on your website/app, you can trigger an add money request to Paytm so that you can complete the payment for your order. Customer can select a pre-set amount or enter a custom amount to add. After customer submits the request, you need to do the following:

      1. Create an order in your order system and generate checksumhash at your server end for payment request. Checksumhash is used for detecting errors or tampering introduced during transmission of request. Checksum is generated using Merchant Key which should be kept only on server side for security reasons. You have to send an additional parameter in the add money request:

        REQUEST_TYPE: ADD_MONEY
        
      2. POST the payload and checksumhash in an HTML. This redirects the customer to Paytm's add money checkout page

      3. Customer fills payment details and completes the payment authentication. Once the payment is complete, response is posted in HTML form POST on your app/website's callback URL

      4. Verify checksumhash received in response to ensure that it has not been tampered with

      5. Customer will now have the money added to her Paytm Wallet and you can continue with checkout

      Steps in Add Money via Paytm Payment Gateway


      Step 1 :

      At the click of Add money button by customer on your website, create an order in your system and generate the required payload for payment request. Parameters of payload are provided below

      Request Attributes


      PARAMETERDESCRIPTION
      REQUEST_TYPE String(50) MandatoryThis parameter is used to identify the transaction flow. Its value for different flows is mentioned below:
      1. 'ADD_MONEY' for the add money request
      MID String(20) MandatoryThis is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MID is available here & production MID will be available once your activation is complete.
      ORDER_ID String(50) MandatoryUnique reference ID for an Order request which is generated by merchant and sent in the transaction request payload. Duplicate order request are rejected by Paytm. It's alphanumeric and special character allowed are “@” “-” “_” “” “.”.
      CUST_ID String(64) MandatoryThis parameter is the unique reference ID for every customer and is generated by the merchant. The allowed special characters for this parameter are @, ! ,_ ,$, .
      TXN_AMOUNT String(10) MandatoryThis is the “Transaction Amount” that is to be charged the customer’s credit card /debit card /bank account / Paytm Wallet. Should contain digits up to two decimal points. Only special character allowed is (“.”) . Please ensure that the amount is in the same currency as defined for the Merchant ID being used.
      CHANNEL_ID String(3)
      Mandatory
      Channel through which API call is initiated.For websites, the value to be passed should be "WEB" and for Mobile websites/App, the value to be passed should be "WAP"
      This parameter is used to control the theme of the payment page. Based on the channel passed, Paytm will render the layout suitable for that specific platform.
      INDUSTRY_TYPE_ID String(20) MandatoryIndustry type should pass here. This will be provided by Paytm. Ex: “Retail”
      WEBSITE String(30) MandatoryWEBSITE Name should passed here. This will be provided by Paytm
      CHECKSUMHASH String(108) OptionalSignature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library available here. Checksum is used to ensure data is not tempered when request is posted in the APIs. In case of checksum mismatch due to data tempering Paytm will reject the request.
      SSO_TOKEN String(36) MandatoryThis is a unique token linked with user's Paytm wallet and is provided in the response while linking user's Paytm wallet.
      CALLBACK_URL String(255) MandatoryOn 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/"

      Step 2 :


      Generate checksumhash using Paytm library with parameters in key value pairs. Using the payload and checksumhash make an HTML form post and redirect customer to Paytm server. Code snippets and Github links for the checksum utility and HTML form post are provided below.

      TreeMap<String, String> paytmParams = new TreeMap<String, String>();
      paytmParams.put("MID", "YOUR_MID_HERE");
      paytmParams.put("REQUEST_TYPE", "ADD_MONEY");
      paytmParams.put("WEBSITE", "WEBSTAGING");
      paytmParams.put("INDUSTRY_TYPE_ID", "Retail");
      paytmParams.put("CHANNEL_ID", "WEB");
      paytmParams.put("ORDER_ID", "ORDERID_98765");
      paytmParams.put("CUST_ID", "CUST_001");
      paytmParams.put("MOBILE_NO", "7777777777");
      paytmParams.put("EMAIL", "abc@xyz.com");
      paytmParams.put("SSO_TOKEN", "10560aff-XXXX-XXXX-a691-5a1376db9000");
      paytmParams.put("TXN_AMOUNT", "1.00");
      paytmParams.put("CALLBACK_URL", "https://merchant.com/callback");
      /* * Generate checksum for parameters we have * You can get Checksum JAR from https://developer.paytm.com/docs/checksum/ * Find your Merchant Key in your Paytm Dashboard at https://dashboard.paytm.com/next/apikeys */
      String checksum = PaytmChecksum.generateSignature(paytmParams,"YOUR_MERCHANT_KEY");
      /* for Staging */ String url = "https://securegw-stage.paytm.in/order/process";
      /* for Production */ // String url = "https://securegw.paytm.in/order/process";
      StringBuilder outputHtml = new StringBuilder(); outputHtml.append("<html>"); outputHtml.append("<head>"); outputHtml.append("<title>Merchant Checkout Page</title>"); outputHtml.append("</head>"); outputHtml.append("<body>"); outputHtml.append("<center><h1>Please do not refresh this page...</h1></center>"); outputHtml.append("<form method='post' action='" + url + "' name='paytm_form'>"); for(Map.Entry<String,String> entry : paytmParams.entrySet()) { outputHtml.append("<input type='hidden' name='" + entry.getKey() + "' value='" + entry.getValue() + "'>"); }
      outputHtml.append("<input type='hidden' name='CHECKSUMHASH' value='" + checksum + "'>"); outputHtml.append("</form>"); outputHtml.append("<script type='text/javascript'>"); outputHtml.append("document.paytm_form.submit();"); outputHtml.append("</script>"); outputHtml.append("</body>"); outputHtml.append("</html>");
      Endpoints:
      Staging: https://securegw-stage.paytm.in/order/process
      Production: https://securegw.paytm.in/order/process

      HTML Form Post

      <html>
          <head>
              <title>Merchant Check Out Page</title>
          </head>
          <body>
              <center><h1>Please do not refresh this page...</h1></center>
              <form method="post" action="https://securegw-stage.paytm.in/order/process?ORDER_ID=YOUR_ORDER_ID" name="paytm">
                  <table border="1">
                      <tbody>
                          <input type="hidden" name="MID" value="YOUR_MID_HERE">
                          <input type="hidden" name="WEBSITE" value="YOUR_WEBSITE_HERE">
                          <input type="hidden" name="REQUEST_TYPE" value="ADD_MONEY">
                          <input type="hidden" name="SSO_TOKEN" value="SSO_TOKEN_OF_USER">
                          <input type="hidden" name="ORDER_ID" value="YOUR_ORDER_ID">
                          <input type="hidden" name="CUST_ID" value="CUSTOMER_ID">
                          <input type="hidden" name="MOBILE_NO" value="CUSTOMER_MOBILE_NUMBER">
                          <input type="hidden" name="EMAIL" value="CUSTOMER_EMAIL">
                          <input type="hidden" name="INDUSTRY_TYPE_ID" value="YOUR_INDUSTRY_TYPE_ID_HERE">
                          <input type="hidden" name="CHANNEL_ID" value="YOUR_CHANNEL_ID">
                          <input type="hidden" name="TXN_AMOUNT" value="ORDER_TRANSACTION_AMOUNT">
                          <input type="hidden" name="CALLBACK_URL" value="YOUR_CALLBACK_URL">
                          <input type="hidden" name="CHECKSUMHASH" value="GENERATED_CHECKSUM_VALUE">
                      </tbody>
                  </table>
              <script type="text/javascript">
                  document.paytm.submit();
              </script>
              </form>
          </body>
      </html>

      Step 3 :


      Customer fills the payment details and is redirected to bank page for authorization. Once the transaction is authorized, Paytm receives the response from the bank and returns a status to your website via your callback URL. Response attributes description and sample HTML form post is provided below :

      Response Sent by Paytm


      ParameterDescription
      MID String(20)This is a unique identifier provided to every merchant by Paytm.
      TXNID String (length: upto 64 digits, datatype: long)This is a unique Paytm transaction ID corresponding to OrderID for which status is being checked.
      ORDERID String(50)Order ID is merchant’s unique reference ID for a transaction sent in request.
      BANKTXNID StringThe Transaction Id sent by the bank In case of Paytm proprietary instruments too, there is unique reference number generated by Paytm's system. In case the transaction does not reach the bank, this will be NULL or empty string. Primary reason for this is user dropping out of the payment flow before the transaction reaches to bank to servers
      TXNAMOUNT String(10)Order value of the transaction in INR. Merchant should validate this amount against that send in transaction request payload. In case the amount does not match, merchant should not provide the services to customer. This is needed to avoid request and response tampering possible at the time of transaction.
      CURRENCY String(3)Currency in which the transaction has taken place. Currently only "INR" is the supported currency of transaction
      STATUS String(20)This contains the transaction status and has only three values: TXN_SUCCESS, TXN_FAILURE & PENDING.
      RESPCODE String(10)Codes refer to a particular reason of payment failure. List in this PDF
      RESPMSG String(500)Description message attached with each RESPCODE. List in this PDF
      TXNDATE DateTimeDate of payment transaction in the format "yyyy-MM-dd HH:mm:ss.S"
      Format - "2015-11-02 11:40:46.0"
      GATEWAYNAME String(15)Gateway used by Paytm to process the transactions. For Credit,Debit Cards and UPI - Gateway used to process the transaction. For example, if HDFC gateway has been used to process SBI credit card transactions, the value will be HDFC.
      For Net banking & wallet, value will be Issuing Bank name and Wallet respectively.
      BANKNAME String(500)Name of issuing bank of the payment instrument used by customer. For Credit Cards Debit Cards, Netbanking - Name of the issuing bank.
      Example in case customer uses SBI's credit card, the value will be "SBI”.
      For Paytm Wallet, value will be Wallet.
      In case of UPI, this parameter will not be present in the response.
      PAYMENTMODE String(15)The payment mode used by customer for transaction
      Credit card - CC
      Debit card - DC
      Net banking - NB
      UPI - UPI
      Paytm wallet - PPI
      Postpaid - PAYTMCC
      CHECKSUMHASH String(108)Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library available here. Checksum is used to ensure data is not tempered via verify checksum method
      <html>
         <head>
           <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
           <title>Paytm Secure Online Payment Gateway</title>
         </head>
         <body>
            <table align='center'>
                  <tr>
                  <td><STRONG>Transaction is being processed,</STRONG></td>
                  </tr>
                  <tr>
                  <td><font color='blue'>Please wait ...</font></td>
                  </tr>
                  <tr>
                  <td>(Please do not press 'Refresh' or 'Back' button</td>
                  </tr>
            </table>
            <FORM NAME='TESTFORM' ACTION='YOUR_CALLBACK_URL' METHOD='POST'>
                  <input type='hidden' name='CURRENCY' value='PAYMENT_CURRENCY'>
                  <input type='hidden' name='CUST_ID' value='CUSTOMER_ID'>
                  <input type='hidden' name='GATEWAYNAME' value='GATEWAY_USED_BY_PAYTM'>
                  <input type='hidden' name='RESPMSG' value='PAYTM_RESPONSE_MESSAGE_DESCRIPTION'>
                  <input type='hidden' name='BANKNAME' value='BANK_NAME_OF_ISSUING_PAYMENT_MODE'>
                  <input type='hidden' name='PAYMENTMODE' value='PAYMENT_MODE_USED_BY_CUSTOMER'>
                  <input type='hidden' name='MID' value='YOUR_MID_HERE'>
                  <input type='hidden' name='RESPCODE' value='PAYTM_RESPONSE_CODE'>
                  <input type='hidden' name='TXNID' value='PAYTM_TRANSACTION_ID'>
                  <input type='hidden' name='TXNAMOUNT' value='ORDER_TRANSACTION_AMOUNT'>
                  <input type='hidden' name='ORDERID' value='YOUR_ORDER_ID'>
                  <input type='hidden' name='STATUS' value='PAYTM_TRANSACTION_STATUS'>
                  <input type='hidden' name='BANKTXNID' value='BANK_TRANSACTION_ID'>
                  <input type='hidden' name='TXNDATE' value='TRANSACTION_DATE_TIME'>
                  <input type='hidden' name='CHECKSUMHASH'  value='PAYTM_GENERATED_CHECKSUM_VALUE'>
            </FORM>
         </body>
       <script type="text/javascript">  document.forms[0].submit();</script>    
      </html> 

      Step 4 :


      Checksumhash received in response of transaction needs to be verified on merchant server using Paytm library with all the parameters in key value pairs. Code snippets and Github links for the checksum utility are provided here

      Step 5 :


      Customer will be able to see the added amount in his/her Wallet.