Reference - Payment methods

✖
Copy to clipboard

On this page, you can find all available settings for configuring payment methods.

You can manage the payment methods on the Payment methods tab in the Store configuration and Multistore configuration applications. See the difference in Choosing site or global e-commerce configuration.

General

Display name

Specifies the name of the payment method displayed to users on the live site and in the administration interface.

Code name

Specifies the string identifier of the payment method object used by developers in the code.

Unless there is a reason to set a particular value, you can leave the default (automatic) option, and the system generates an appropriate code name.

Description

Allows you to type a text description for the payment method in order to provide further information.

Teaser image

Allows you to add a teaser image that the system displays to store visitors on the live site. Other types of files such as documents, and audio and video files can also be uploaded.

Allow if no shipping is supplied

Specifies whether the payment method is offered to the customer if no shipping is needed. An order does not require shipping if there are no products with the Needs shipping property enabled placed to the shopping cart.

Select the check box if the payment method is offered even when shipping is not needed. Typically, you may want to disable payment on delivery when the customer is buying only e-books or other downloadable electronic products. In that case, clear the check box.

Enabled

Specifies whether you can use the payment method object in your on-line store. If selected, you can select the edited payment method during making an order, either on the live site or from the Payment method drop-down list when editing orders on the Billing tab.

Payment gateway

Payment gateway URL

Specifies the URL of the payment gateway.

Note: Not all payment gateways work with this URL value (for example the default PayPal payment gateway does not). For custom gateways, this depends on the implementation.

You can add parameters into the URL using macros, for example:
https://custompaymentgateway.com?currency={%Currency.CurrencyCode%}&total={%GrandTotal%}

Payment gateway provider class

Specifies the name of the DLL assembly where the payment provider is stored, and the name of the corresponding class that represents the payment provider.

Choose the following values for the default payment gateways:

  • Assembly name: CMS.Ecommerce
  • Class:

Order status if payment succeeds

Specifies a status that the provider automatically assigns to orders after a payment is successfully completed (either by direct payment transactions or after capture of funds when using delayed capture).

By clicking New or by selecting (new item…), you can create a new order status.

Order status if payment is authorized

Specifies a status that the provider automatically assigns to orders after successful payment authorization (if the payment is not fully completed).

Used by payment methods that support delayed capture transactions – initial payment only performs authorization without actually transferring funds, and the merchant later finishes the transaction by capturing the payment.

For example, the default PayPal and Authorize.NET payment gateways can be configured to use delayed capture transactions.

Order status if payment fails

Specifies a status that the provider automatically assigns to orders if a payment transactions fails (either standard payment, authorization, or capture of funds).