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

      Auto Debit

      Auto-debit is a one-click payment experience for your website or mobile app enabling payments via Paytm wallet, Paytm postpaid and your gift vouchers issued by Paytm. Your customers need to authorize and link their Paytm account with your application once and enjoy superfast checkout every time after that.

      Note: Paytm Auto-Debit is only available to select enterprise customers with high transaction volumes and established businesses. Get in touch to request access to Paytm Auto-Debit payment solution.

      Demo of Auto Debit


      Overview of payment processing via Paytm Auto-Debit


      1. User visits your website or mobile application
      2. You ask the user to link his/her Paytm account for seamless payments
      3. You initiate the account linking process using Send OTP API and Validate OTP API
      4. Once user account is successfully linked, Paytm shares the user SSO_TOKEN with you
      5. User adds goods/services into the shopping/order cart
      6. You calculate the total order amount and call the Paytm Fetch Instrument API
      7. Paytm returns all applicable instruments having sufficient balance out of (Paytm Wallet, Paytm Postpaid and Merchant Gift Voucher) as per customer and merchant combination.
      8. User selects the payment instrument from the listed options and merchant calls the Auto Debit API with the selected instrument to deduct funds
      9. In case balance is insufficient in all the payment instruments returned in Fetch Instrument API, you can invoke Paytm App to complete payment.
      10. Post payment completion call the Transaction Status API to verify the transaction response
      11. Notify the payment status to user and proceed with the order/service fulfillment

      Steps in processing payments via Paytm Auto-Debit


      STEP 1: Get your authentication keys

      Note: Paytm Auto-Debit is only available to select enterprise customers with high transaction volumes and established businesses. Get in touch to request access to Paytm Auto-Debit payment solution.
      1. Client ID: a unique alphanumeric identifier issued by Paytm for your account
      2. Client Secret: a unique alphanumeric key issued by Paytm for your account
      3. MID: A unique merchant identifier issued by Paytm for your account
      4. Merchant Key: A 16-digit unique identifier issued by Paytm for your account
      Note: Client Secret and Merchant Key are secret keys used for encryption so never share these with anyone

      STEP 2: Link a user’s Paytm account with your application

      Demo of Paytm Account Linking


      Find the detailed interaction of each system component for Paytm account linking in the flowchart below:


      Use the following APIs to link a paytm account, validate the linked account and remove linked account

      • Send OTP API: Send user’s 10-digit mobile number to Paytm. We will send an OTP to the user’s mobile number to continue with authorization
      • Verify OTP API: Accept the OTP entered by user, verify it and receive the user token. The validity of the token will always be verified by your Paytm Client ID that is provided by Paytm

      Validate account linking

      Remove account linking

      • Revoke Access API: Used for expiring user’s token. This is required when a customer deletes/delink his/her account or logs in with a new mobile number in your application


      STEP 3: Fetch available Payment instruments

      You must ensure that the user has enough balance to pay for the order in the selected instruments from the response of Fetch Instruments API before initiating Auto Debit

      Demo of Paytm app invoke in case of insufficient balance


      Flow diagram of Paytm app invoke in case of insufficient balance
      If any of the proprietary payment instruments don’t have sufficient balance then invoke Paytm App for payment.
      For example: A user has Rs. 200 in her Paytm Wallet, Rs. 150 in Paytm Postpaid and Rs. 100 in Merchant Gift Voucher and transaction amount for the order is Rs. 500. In this case, no payment method has sufficient funds hence you need to invoke Paytm App for making payment

      STEP 4: Debit amount from user's Paytm account and confirm the transaction

      Now that you have ensured that your customer has enough balance to pay for the order, you can debit the amount using the Auto Debit API and confirm the transaction using Transaction Status API


      STEP 5: Managing Refunds

      If you need to cancel or refund a successful transaction, you can do so by simply sending a Refund API request and ensuring success using the Refund Status API.


      On completion of your integration -


      Post completion of integration on your staging environment, do a complete transaction from order summary page on your website or mobile app

      1. Attempt a test transaction using test paymodes credentials

      2. Ensure you re-verify transaction response with Transaction Status API via server to server call in payment flow and not separately as a one time activity

      3. See the transaction details in "Test Data" mode on your dashboard

      Once the test transaction is complete, move your code to live environment with production account details, which you would have received from Paytm.

      Lastly, it's recommended that you read about Managing Refunds and late payment notifications

      In case of any issues with integration, please get in touch