search

Paytm Payment Links

Paytm Payment Links are used to collect payments from your customers, wherever they are. A Payment Link is a simple web address that can be shared via SMS, email or your favourite chat software with one or many customers. When your customers click on the link, they can complete payment either via Paytm app if it’s installed on your customer’s phone or via a simple payment page that opens in a web/mobile web browser.

 

Payment Links can be created via your Paytm Dashboard or via APIs. Your customers do not need to have a Paytm account to pay you using Payment Links.

 

Payment Links can be customized according to your requirements:

Type of Link Description
Generic Link There is no limit on number of customers, payments or amount.
Fixed Amount Link There is no restriction on number of payments but the amount is fixed.
Payment Page You can collect customer details by capturing additional information during payments.
Invoice Link Send detailed invoices with product wise amount breakdown

Demo of Payment via Payment Links

Overview of Payment Processing via Paytm Payment Links

  1. You can create Payment Links manually via Paytm Dashboard.

  2. Use the Create Link API when you need to generate links in bulk or within your application.

  3. Specify the mobile number and email Id to send link via SMS/Email automatically after the link creation.

  4. Use the Resend Notification Link API to resend the link to any mobile number/email address in case you need to remind a customer for payment.

  5. When your customer clicks the link, one of the following happens:

    1. If your customer has the Paytm App installed, the app is invoked to make payment

    2. If your customer does not have the Paytm App installed, payment link opens in a desktop/mobile browser

  6. Customers can pay using all available payment methods on your account - Paytm Wallet, UPI, Paytm Payments Bank, Credit/Debit Cards, Netbanking, Paytm Postpaid, and more.

  7. Once a customer completes the payment, a Payment Callback Notification is sent to your Callback URL specified at the time of link creation. In case a Callback URL is not specified, the notification is sent on the registered Callback URL submitted at the time of account creation.

  8. You can get a list of all the links you have created using Fetch Link API. Get the details of payments against the link using the Fetch Transaction API.

Find the detailed interaction of each system component in the flowchart below:

 

Payment Links Status

A Payment Link can have any of the following statuses after creation:

 

Status Description
issued Payment link is created and sent to the customer (if applicable)
paid Payment for the link is completed by the customer. This is only relevant for Invoice Links.
cancelled Payment link has been cancelled
expired Payment link has expired. Merchant can set an expiry timestamp at the time of creation

Steps in processing payments via Paytm Link API

STEP 1: Get your authentication keys

Generate your staging account credentials from the dashboard.

  • MID (Merchant ID): This 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 and production MID will be available once your activation is complete.
  • Merchant Key: This is a unique secret key used for secure encryption of every request. This needs to be kept on server-side and should not be shared with anyone.

Please note: Client Secret and Merchant Key are secret keys used for encryption so never share these with anyone.

STEP 2: Create a Payment Link & share it with your customer

 

Demo of Link Creation

 

The following is a representative demo of how you can create payment links in your own application:

  • Create a Payment Link with the Create Link API. You can specify the mobile number and email of the customer if you want to send this link to the customer on Email & SMS respectively. Partial Payments can be configured on links using this API to let customers pay multiple times on the link until it is marked paid.

  • You can modify the link anytime using the Update Link API. Please note you can only modify the Link Description and Expiry date.

  • You can cancel a link anytime using the Expire Link API. Your customer would not be able to complete payment once the link is expired.

  • You can resend the Link to your customer on any Email ID and Mobile number by using the Resend Link API.

Payment Pages: Collect additional information from customers dropdown

You can accept information from your users by sending a form along with the payment link. The customer journey will be as follows:

  1. Customer clicks the payment link.

  2. Form is opened in the web or mobile browser.

  3. Post filling the required fields the customer proceeds to payment.

  4. If your customer has the Paytm App installed, the app is invoked to make payment.

  5. If your customer does not have the Paytm App installed, the payment process is continued in the desktop/mobile browser.

 

You can attach a form to your link using any of the following two ways:

  1. Create a form template using the Paytm Merchant Dashboard

    1. Go to Paytm’s Dashboard and click Payment Links.

    2. Create a Payment Link and click Capture Additional Details to start creating a form template.

    3. Once you create a template, you will get a Template ID.

    4. Use this Template ID in the Create Link API to send the form along with your Payment Link.

  2. Create the form using APIs

    1. Use the Fetch Suggested Fields API to start creating a form. Suggested fields will help you create forms faster by showing you pre-created fields.

    2. Once you have decided the fields in your form use the Save Template API to save the form template. A Template ID will be linked to each of the templates.

    3. Use the Fetch Templates API to attach a previously saved form template to your link. 

    4. Use this Template ID in the Create Link API to send the Form along with your Payment Link.

    5. Using the Fetch Template Fields API, the fields related to a Template ID will be populated.

    6. If you wish to delete a saved field use the Delete Custom Field API. You can also delete a template by using the Delete Template API.

 

STEP 3: Payment Confirmation and Reconciliation

  • Once your customer has completed payment via the link, you will receive a Payment Callback Notification on your server basis which you can update the payment status at your end.

  • To check if any payments have been made against the link, please use the Fetch Transaction API.

  • You can use the Fetch Links API to show the list of links created in your own dashboard. Use the Fetch Transaction API to fetch details of payments made against these links.

 

STEP 4: 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.

REFID - REFID parameter in Refund API should mandatory be sent as Unique ID for every refund request sent to Paytm.The refund request can fail due to insufficient funds in MPA (Merchant Payable Account). For failure refund status, the merchant can retry refunds. However, for Pending refunds merchant should not retry refund.

On completion of your integration

Once the test transaction is complete, move your code to live environment with production account details. Note that production accounts details are available after you have activated your account on the dashboard.

 

In case of any issues with integration, please Get in touch.