Home  >   Articles   >  Setting up Autopay & Payment Gateways
Articles in this section

Setting up Autopay & Payment Gateways

This article will guide you to configure different payment gateways in the CRM.
Rashmi Kashyap
12 Nov, 2023 - Updated 8 months ago
Table of Contents


Payments & Subscriptions Settings in Vtiger CRM is the backbone of the Payments and Subscriptions module.

In this article, you will learn how to configure different payment gateways that will help you to receive or make payments and also configure auto-pay for all your subscriptions.

Adding a Payment Gateway

It is necessary to configure payment gateways to create a smooth payment process for your customers. This configuration will be mostly used in the Payments module.

In this section, you will learn how to add a payment gateway to make payments in Vtiger CRM. Currently, we offer three secure gateway merchants:

  1. PayPal
  2. Authorize.Net
  3. Stripe

Follow these steps to add a payment gateway:

  1. Login to your account.
  2. Click the User Menu icon on the top right corner of the screen.
  3. Click the Settings button.
  4. Lookout for Inventory sections.
  5. Select Payments & Subscriptions.
  6. Click the +Add Gateway button.
  7. In the Add Configuration window, you can configure any of the following gateways:
  8. After entering all the necessary configuration information, click Save.


  1. To edit a payment gateway, hover over a gateway record and click the edit icon in the List View.
  2. To delete a payment gateway, hover over a gateway record and click the delete icon in the List View.


Configuring PayPal gateway

The PayPal Digital Goods Checkout payment method helps you to accept payments through a secure PayPal gateway. To achieve this, you’ll need to have a PayPal Business Account to accept payments online. 

To know more about adding a PayPal business account, click here.

  1. Provider: Select PayPal.
  2. Active: To enable or disable your merchant account.
  3. Label: Enter your desired username.
  4. API User ID: Enter API Login ID provided by your PayPal Payment Gateway.
  5. Password: Enter the password provided by your PayPal Payment Gateway.
  6. Signature: Paste the API Signature from PayPal.

To know more about PayPal and its features and benefits, click here.


Note: The API User ID, Password, and Signature will be available in your business account in PayPal. 


Configuring Authorize.Net gateway

  1. Provider: Select Authorize.
  2. Active: To enable or disable your merchant account.
  3. Label: Enter the desired username.
  4. API Login ID: Provide the API Login ID provided by your online payment gateway.
  5. TransactionKey: Provide Transaction Key provided by your online payment gateway.
  6. SilentPostURL: Use the right-click on the link next to the field and copy the link address. 
  7. Now log in to your Authorize.Net account.
  8. Click the Account tab.
  9. Click Silent Post URL and paste it in the URL field.

To know more about the features and benefits of Authorize.Net, click here.


Configuring Stripe gateway

  1. Provider: Select Stripe.
  2. Active: To enable or disable your merchant account.
  3. Label: Enter the desired username.
  4. Publishable Key: Enter the key provided in the stripe account.
  5. Secret Key: Enter the secret key available in the stripe account.

Setting Up Autopay Configuration

The primary and the most important requirement for setting up autopay configuration is to configure either Authorize.Net or Stripe Gateway.

Autopay configurations are mainly used for the Subscriptions module.

You need to configure Autopay only if the subscription is set to auto-payment mode.

Follow these steps to configure Autopay:

  1. Click the display picture on the right-hand top corner of the screen. 
  2. Click Settings.
  3. Click Payments and Subscriptions under Inventory.
  4. Click the Autopay Configuration tab.

Here you will see the screen divided into four sections:

  • Payment Success
  • Payment Failure
  • Payment Retry Attempts
  • Failure Attempts

For better understanding, we have grouped the above sections.

Actions in Autopay

When autopay is on for a subscription, you can define the actions that you want to perform if the payment is successful or failure.


Follow these steps to configure the actions:

  1. Hover over the default action under Payment Successful or Payment Failure.
  2. Click the Edit icon.
  3. Enter a title for the action.
  4. Enable or disable the action by clicking the checkbox.
  5. Select the operation that has to be done when the action takes place.
    1. Send Email: The system sends an email to the customer about payment and invoice related details. Standard email messages have already been set up by Vtiger. You can use these available messages or you can change them to suit your business by going to Email Templates.
    2. Do Nothing: By selecting this option, you can undo any action on payment success or failure.

Retry rules in Autopay

Whenever a payment to a subscription fails, you can notify your customer about the status of the payment and the issues regarding their account through an email. 

You can also comfort them by telling them that you will retry the payment again after a couple of days using retry rules in Vtiger CRM.

Yes, it's true. You don’t have to worry about losing a subscription because Vtiger CRM has been modeled to retry failed subscription payments! With Vtiger CRM you can decide on:

  • The number of retry attempts on a particular subscription. 
  • The schedule or time duration when the payment will be retried next.

Now, let’s learn the nuances of this feature:

  • Firstly, you can decide the Retry Limit for every payment on a subscription. You can have a minimum of zero or a maximum of three retry payment attempts. 
  • Secondly, you can set up certain rules based on the number of retry limits.
    • For example, if your retry limit is three, then you can decide the duration, the operation, and the template for all three retry attempts.
  • Lastly, you can suspend the subscription by enabling the Suspend Subscription after all failed attempts check box if the payment process fails even after the final attempt. You can either notify your customer about this by sending an email or do nothing.
Retry rules


Was this article helpful?
0  out of  0  found this helpful.
Comments 0
Be the first to comment
© Copyright 2023 Vtiger. All rights reserved.