Creating a payment method

A payment method can be created using one of the plugins (see Viewing the list of plugins) or payment gateway connectors (see Viewing the list of payment gateway connectors). The list of payment method settings depend on the selected plugin or payment gateway connector.

In this article:

Creating a payment method based on a plugin

To create a payment method based on a plugin:

1. Go to Payment Methods (see Navigation). The list of payment methods is displayed (see Viewing the list of payment methods).
2. Click Create. The New Payment Method page is displayed.
3. In the Payment method information group:
   1. Optionally, if it is necessary that the payment method not be available for use right after creating, clear the Enabled checkbox.
   2. In the Name field, enter the payment method name displayed in the Customer Control Panel and Operator Control Panel.
   3. In the Account types group, select the checkboxes of the account types (see Account types) that can use this payment method.
   4. Optionally, in the Icon field, click Choose File and select the logo for the payment method. This logo will be displayed in the Operator Control Panel and Customer Control Panel.
      
      
   
   
   

4. In the Integration type group, select Payment Plug-in.
   
   
   
   

5. In the Plugin list, select the required plugin for connecting to a payment system (see Viewing the list of plugins).

6. In the Additional Settings group, specify the required options. The additional settings depend on the selected plugin.

   Example for the CheckCash plugin

   To configure a payment method based on the CheckCash plugin, specify the following settings:

   1. Instructions Template (in Liquid format) — a template of the instruction displayed to a customer. HTML, CSS, JS, and placeholders (see Placeholders for configuring payment methods) are supported.

   2. PDF Template (in Liquid format) — a template of the PDF receipt. HTML, CSS, JS, and placeholders (see Placeholders for configuring payment methods) are supported, for instance, payment.pdf_url and payment.external_file_url to insert a download link to a receipt.

   3. Receipt File Name — the receipt name. Placeholders (see Placeholders for configuring payment methods) are supported. For example, receipt_{{payment.document_id}}.pdf.
      
      
      

7. Optionally, in the Description field, enter information about the payment method displayed in the Customer Control Panel. HTML, CSS, JS, and placeholders (see Placeholders for configuring payment methods) are supported.

   
   
   
   

8. Click Create.

Creating a payment method based on a payment gateway connector

To create a payment method based on a payment gateway connector:

1. Go to Payment Methods (see Navigation). The list of payment methods is displayed (see Viewing the list of payment methods).
2. Click Create. The New Payment Method page is displayed.
3. In the Payment method information group:
   1. Optionally, if it is necessary that the payment method not be available for use right after creating, clear the Enabled checkbox.
   2. In the Name field, enter the payment method name displayed in the Customer Control Panel and Operator Control Panel.
   3. In the Account types group, select the checkboxes of the account types (see Account types) that can use this payment method.
   4. Optionally, in the Icon field, click Choose File and select the logo for the payment method. This logo will be displayed in the Operator Control Panel and Customer Control Panel.
      
      
   
   
   

4. In the Integration type group, select External Payment Gateway.
   
   
   
   

5. In the Payment gateway connector list, select the required payment gateway connector for connecting to a payment gateway (see Viewing the list of payment gateway connectors).

6. In the Connector settings group, specify the required options. The displayed settings depend on the JSON schema of the selected payment gateway connector (see Creating a payment gateway connector).

   Connector settings example

   

7. Optionally, in the Description field, enter information about the payment method displayed in the Customer Control Panel. HTML, CSS, JS, and placeholders (see Placeholders for configuring payment methods) are supported.

   
   
   
   

8. Click Create.