Documentation Home »User Guide: Commerce »Payment »Payment Configuration
3.0 version
You are currently viewing documentation for version 3.0 which is not a long-term support release. The latest long-term support release is version 1.6

Payment Configuration

System Configuration: Merchant Location

Merchant location is a system-wide setting that applies to all websites.

To configure the merchant location:

  1. Navigate to the system configuration (click System > Configuration in the main menu).
  2. Select Commerce > Payment > General in the menu to the left.

Note

For faster navigation between the configuration menu sections, use Quick Search.

The following page opens:

../../../_images/merchant_location.png
  1. To customize the merchant location:

    1. Clear the Use Default box next to the option.
    2. Select a new country from the list.
    3. Click Save.

Payment Method Integration

You may configure integration with third-party payment providers to offer their payment services for the quotes and orders placed using OroCommerce.

Generic Payment End-to-End Flow in OroCommerce

Any third party payment system integration involves the following steps to enable it for the OroCommerce Storefront customers:

  1. A B2B seller signs up for payment provider services (e.g. PayPal Business Account).

  2. A B2B seller administrator or integrator obtains integration information using the service information resulting from the first step (e.g. partner ID, partner login credentials, etc.). Integration information may include credentials, security tokens, etc. These details may be generated by the payment provider for a B2B seller, or a B2B seller may generate some of these items using the payment provider services.

  3. Sometimes for secure connection, a B2B seller administrator or integrator supplies the payment provider with identification and authentication artefacts, like secure public key, secure certificate or authentication token. Private tunnel and proxy may be used for advanced security of the payment related traffic.

    Note

    Every sandbox, testing, and production environment should use a unique, dedicated set of integration details. Usually, payment service providers allow test mode access with debug level information. It is crucially important to use the test and debug set of access details only for the test and sandbox environments.

    Warning

    Never use test integration access in production mode or on the production servers as this might expose your customers to the sever security risks.

  4. Once the integration and connection details are available, the B2B seller administrator or integrator may setup an integration of the payment provider services into OroCommerce.

  5. Next, the administrator may limit the availability of the particular payment methods (enabled by the payment provider services integration) using the payment rule configuration.

  6. Once the payment configuration is complete, the payment methods may be used by customer users during the checkout. Payment may be captured immediately or authorized for delayed capture.

  7. A sales person can view payment history and capture the delayed payment (e.g. when the order is complete and is ready for shipping).

Create an Integration with a Payment Method Provider

Out of the box, you may integrate OroCommerce with the following systems and services (click the links for detailed guidance):

Delete an Integration with a Payment Method Provider

This section describes the steps that are necessary to delete integration with the payment provider and disable payment methods they offer in OroCommerce orders and quotes.

To delete an integration and related payment methods:

  1. Navigate to System > Integrations > Manage Integrations in the main menu. The Manage Integrations page opens.

  2. Hover over the More Options menu at the end of the row with the necessary integration and click the Delete icon.

    The confirmation dialog appears.

    If any payment rule depends on the integration that is being deleted, the affected payment methods in those payment rules will be disabled. The payment rule might also be disabled if none of its payment methods remain enabled.

  3. If necessary, review the payment rules using the link in the confirmation dialog.

    Note

    The payment rules open in a new tab in your browser.

  4. Once you are ready to delete the integration, click Delete.

The payment methods that were based on this integration are no longer usable in OroCommerce and cannot be enabled in the payment rule.

Payment Rules Configuration

You can configure one or more payment rules that enable the payment methods for the provided destinations.

Note

See a short demo on how to create payment rules, or keep reading the step-by-step guidance below.

Create a Payment Rule

To create a payment rule:

  1. Ensure that the integrations for the payment methods that you plan to use (PayPal Payflow Gateway, PayPal Payments Pro, etc.) are already configured.

  2. Navigate to System > Payment Rules in the main menu. The list of payment rules opens.

  3. Click Create Payment Rule. The corresponding page opens.

  4. In the General Information section:

    1. Select the Enabled check box to activate the payment rule. You may keep it clear while you are drafting and testing the conditions.

    2. Specify the payment rule name and sort order to set the priority compared to other payment rules.

    3. Select the payment currency.

      Important

      When setting a payment rule for the PayPal integration, make sure to select the currency that PayPal supports, otherwise the payment will not be processed. For the list of currencies supported by PayPal, refer to the Currency and Currency Codes section.

    4. Select Stop Further Rule Processing if you would like to prevent applying other payment rules with lower priority.

  5. In the Destinations section, add one or more destinations to apply this payment rule for. The payment rule applies when the billing address matches the provided destination(s). To add a destination:

    1. Click + Add. The following section appears:

      ../../../_images/create_payment_rule.png
    2. Specify the destination (e.g. select a Country, or select a country and state; for the most granularity you may provide a distinct list of postal codes to apply the payment rule for.

  6. In the Conditions section, specify the expression that describes the conditions when this payment rule should be applied. For example, account = 1.

    ../../../_images/create_payment_rule_expression.png

    For detailed information about the expression language used in the shipping and payment rules, please see the Expression Language for Shipping and Payment Rules guide.

  7. In the Payment Method Configurations section, you may enable one or more payment methods with this payment rule. To add a payment method, select it from the list and click + Add.

    Warning

    Only one unique payment method per integration may be selected in the payment rule.

    PayPal:

    To enable several PayPal Payflow Gateway/ PayPal Express options with different payment settings, create a separate payment rule for every unique option and for each specific currency. Find the list of currencies supported by PayPal in the PayPal Currency and Currency Codes topic. You still can use one copy of PayPal Payflow Gateway and one copy of PayPal Payflow Gateway Express Checkout in the same payment rule, as these are different payment methods.

    Wirecard:

    The single Wirecard integration enables you to set up the following payment methods:

    • WireCard – Credit Card—Via this payment method a buyer can pay for the order using a credit card.
    • WireCard – PayPal—When this payment method is used, a buyer is redirected to the PayPal site where they can complete the payment using their PayPal account or credit card.
    • WireCard – SEPA—Via this payment method a buyer can pay for the order in EUR using a SEPA (Single Euro Payment Area) payment.

    You can add any combination of these payment methods in a single payment rule. However, if you want to enable WireCard – SEPA, then in step 3 you must select EUR for Currency.

  8. In the Websites section, specify the website(s) that the payment rule should apply to, if you have more than one website. This field is optional and may be left empty. Hold the Ctrl key to choose several websites, if necessary.

    Note

    Please note that application of payment rules to websites is only available for Enterprise customers.

    ../../../_images/websites_payment_rule.png
    • When no website is selected, the payment rule is always applied by default.
    • When at least one website is selected, the payment rule will apply to the orders created in the storefront of the specified website.
  9. Click Save.

Manage a Payment Rule

Enable a Payment Rule

To enable a payment rule:

  1. Navigate to System > Payment Rules in the main menu. The list of shipping rules opens.
  2. Hover over the More Options menu at the end of the row with the necessary payment rule.
  3. Click the Activate icon.

To enable several shipping rules at the same time:

  1. Select the checkboxes on the left of the corresponding rows. The selected payment rules will be highlighted in yellow.

  2. Click on the far right of table header.

  3. Click Enable.

    ../../../_images/mass_action_payment_rule.png

Filter a Payment Rule List

You can use filters on the payment rules list page to find the required records quicker:

  1. To show filters, click above the table on the far right.

    ../../../_images/filter_payment_rule.png

    Filters are hidden by default.

  2. To apply a filter, click on its button in the bar, and specify your query in the control that appears.

    Note

    Filter controls might look different depending on the type of data you are going to filter, e.g. textual, numeric, a date or an option set.

    ../../../_images/filter_payment_rule_2.png

Organize a Payment Rule List

To define which columns to show in the table, click above the table on the far right:

../../../_images/grid_settings_payment_rules.png
  • To choose the columns to be displayed in the table, select the check box next to the required column under Show. Clear the check box to make the column disappear from the table.
  • To change the order of the columns, click next to the name of the column you wish to move, hold the mouse button and drag the column to the required position.
Browse maintained versions:
3.01.6

You will be redirected to [title]. Would you like to continue?

Yes No
sso for www.magecore.comsso for oroinc.desso for oroinc.frsso for marketplace.orocommerce.comsso for marketplace.orocrm.com