1. Creating payment workflows

Payment workflow in Zoho Creator enables you to collect and manage online payments directly from your Zoho Creator forms. It allows you to define when a payment should be initiated, what amount should be charged based on a field in a form, and what actions should be performed based on the transaction result. Before you create a payment workflow, you must establish a payment gateway by mapping your payment gateway credentials in Zoho Creator. This is a one-time process. Payment workflows now rely on Payment Gateways powered by Zoho Checkout. You must configure them in Operations > Payment Gateways to continue processing transactions. Learn more about payment gateways

1.1. See how to create payment workflows

1.2. Step for creating payment workflows

1. Navigate to your application in edit mode and click the Add icon () in the top header strip. All application components will be displayed.
   
2. Select Workflow in the Create New Component screen. All workflow types will be displayed.
   
3. Choose On a payment activity. If you have configured payment gateways, this will open the payment workflow creation page.
   
   1. If you haven't created payment gateways before, you'll be prompted to create payment gateways as shown below (This is a one-time process):
      1. Click Configure to set up a payment gateway.
         
      2. Select the payment gateway that you want to configure the payment process.
         
      3. Enter the Connection Name in the add connection pop-up and click Create and Authorize.
         
      4. Enter the gateway details such as country, the currency that you want to process the payment, email, and payment options and Name of authorizing account . Click Authorize.
         Note:
         - Payment gateway setup requires the details/credentials of the payment gateway that you must enter in the configuration page to authenticate and establish a connection with Zoho Creator. The details/credentials required will vary from one payment gateway to the other. Login to your payment gateway account to find the required information.
         - The currency selected must match the currency fields currency type in your Creator form for successful workflow creation.
         

Once you configure a payment gateway, the connection will be added to your Zoho Creator account. The added connection will be set as the default payment gateway for all the payment workflows that you configure in your application. If you want to view or modify the payment connections in your account, go to Operations > Payment Gateways. After this you can continue creating the payment workflow.

4. Choose the form for which you want to set the payment workflow.

Note: If the payment gateway access for this application is not enabled, you'll be promoted to enable it from an alert message. Click Allow Application Access to enable access.

Alternatively, you can also open the payment workflow creation page from the application's edit mode > Workflows tab > Payments. Click either Create Workflow (visible only when no workflows exist) or New Workflow button to add a new one.

5. Select the amount field from the supported field types, such as currency, number, or decimal, to determine the payment amount, and then provide a name for the workflow.
   
6. Select when to run the payment process for. By default, it will be set as Always, which means the payment action will execute for all records. To run the action only for specific records, choose on condition and define the necessary condition or criteria. Learn more about configuring conditions in a workflow. 
7. Click Create Workflow. Payment workflow will be created and you'll be directed to the workflow builder.
   

2. Managing payment workflows

Payment workflows include the following manage options:

1. Enabling or disabling payment workflows
2. Deleting payment workflows
3. Modifying the payment workflows properties
4. Managing integrations in payment workflows
5. Rearranging the payment workflow actions
6. Editing and deleting the payment workflow actions criteria
7. Editing and deleting the payment workflow actions

2.1. Enabling or disabling payment workflows

Note: Disabling the workflow will temporarily suspend its execution without deleting it.

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names.
   
2. Click the Status toggle next to the preferred payment workflow to enable or disable it.
   

2.2. Deleting payment workflows

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names.
   
2. Hover over the workflow and click on the delete icon ()that appears to delete the workflow permanently.
   

2.3. Modifying the payment workflows properties

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names. Click the preferred payment workflow to open the workflow builder.
   
2. Click the gear icon () icon in the top right corner of the workflow builder to open the Workflow Properties slider.
   
3. The following configuration can be managed from the Workflow Properties slider.
   1. Workflow name: Edit the existing workflow name to rename the payment workflow.
      
   2. Run this process: Modify or add new criteria to execute the payment process.
      1. If no criteria were defined while configuring the payment workflow, it will be set to Always. If criteria were already defined during workflow creation, they will be displayed here.
         1. To add criteria to the payment workflow, click on condition.
            
         2. To modify the existing criteria, click on the displayed criteria.
            
      2. Define the required logic in the Edit Criteria pop-up and click Save Criteria.
         
   3. Amount Field: Modify the amount field by selecting another field from your form to determine the payment amount.
      
4. Close the Workflow Properties slider after making the changes. The modified changes will be saved automatically.
   

2.4. Managing integrations in payment workflows

The manage integrations option in payment workflows allows you to configure and manage payment gateways directly from the workflow builder. You can quickly access all gateway-related settings without leaving the builder interface. This section enables you to:

1. View all authorized payment gateways configured in your Zoho Creator account.
2. Add a new payment gateway by authorizing
3. Revoke authorization for a payment gateway

You can also perform the above actions and other manage actions directly from the Payment Gateways in the Operations module of your Zoho Creator account. Learn more about managing payment gateways

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names. Click the preferred payment workflow to open the workflow builder.
   
2. Click the integrations icon () icon in the top right corner of the workflow builder to open the Manage Integrations slider.
   

You can view all the authorized payment gateways in your Creator account.

3. The following configuration can be managed from the Manage Integrations slider.
   1. Add new payment gateway: Adds new payment gateway to your payment workflow.
      1. Click + Add New hyperlink near the Authorized Payment Gateways.
         
      2. Select a payment service from the list of available services and authorize it.
         
         Note: Payment gateway setup requires the details/credentials of the payment gateway that you must enter in the configuration page to authenticate and establish a connection with Zoho Creator. The details/credentials required will vary from one payment gateway to the other. Login to your payment gateway account to find the required information. 
   2. Revoke Authorization: Removes the gateway's authorization, and payments can no longer be processed through this gateway.
      Note:
      1. Hover over any of the authorized payment gateways, click on the horizontal ellipsis icon () , and select Revoke.
         
      2. Click Yes in the confirmation pop-up that appears.
         

2.5. Rearranging the payment workflow actions

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names. Click the preferred payment workflow to open the workflow builder.
   
2. Click and drag on the left slider or on the action block to rearrange it entirely within the Payment Success or Payment Failure section.
   
3. Hover over an action within the action block, then click and drag on the drag handle to rearrange the actions within the action block. You can also move the action from one action block to another within the Payment Success or Payment Failure section.
   

2.6. Editing and deleting the payment workflow actions criteria

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names. Click the preferred payment workflow to open the workflow builder.
   
2. Hover over the criteria on top of the action block to reveal the edit () and delete icons (). If criteria is not configured for the action block, only the edit icon will be visible.
   
3. Click on the edit icon () to open the Edit Criteria pop-up.
   
   1. Modify the existing criteria or add new ones, then click Save Criteria.
      
4. Click the delete icon () to remove the criteria from the action block.
   

2.7. Editing and deleting the payment workflow actions

1. Navigate to the Payments tab under the Workflows section in the edit mode of your application. All payment workflows configured in the application are listed here, grouped by their respective form names. Click the preferred payment workflow to open the workflow builder.
   
2. Hover over the action inside the block to reveal the () and delete icons ().
   
3. Click the edit icon() or directly click on the action to modify its configuration.
   
4. Click the delete icon() to remove the action entirely.
   

3. Related links

1. Understanding payment workflows
2. Configuring notification actions for payment workflows
3. Configuring data access actions for payment workflows
4. Configuring Deluge script for payment workflows
5. Configuring integration actions for paymnet workflows