Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs 4406: Update plugin settings #3159

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Docs 4406: Update plugin settings #3159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
458ec4d
DOCS-4406: Update plugins main pages
JesseSnnt Oct 22, 2024
06af7c1
DOCS-4406: Update plugins main pages
JesseSnnt Oct 22, 2024
507f578
Automated external URL lint.
github-actions[bot] Oct 22, 2024
e901c1b
Merge branch 'master' into DOCS-4406
JesseSnnt Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/integrations/ccv-shop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ ___

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/craft-commerce.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Supported since release: 1.2.0, March 19th 2021.

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/cs-cart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ Extra options such as **IP-Validation** and **Debug mode** are intended for deve

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/drupal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Supported since release: 3.0.0, March 19th 2021.

### Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
4 changes: 4 additions & 0 deletions content/integrations/lightspeed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ When you generate a payment link in your MultiSafepay dashboard, you cannot upda

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down Expand Up @@ -284,6 +286,8 @@ To change the order in which payment methods appear on your checkout page, follo

To set the payment method order for different languages, under the **Payment method settings** select a country / store language and set the order per language.

To add a new language, go to **Settings** > **Store Country** > **Add Language** and include the desired language.

If no specific rule is set for a country, the **Default** order is used.

</details>
Expand Down
38 changes: 37 additions & 1 deletion content/integrations/magento-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,23 @@ Please note that the full shipping amount will be captured whenever the first sh

</details>

## Order confirmation email

You can set the **stage** at which you want a confirmation email for an order to be sent.

<details id="send-order-confirmation-email">
<summary>How to set when an order confirmation email is sent</summary>
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
<br>

1. Sign in to your Magento 2 backend.
2. Go to **Stores** > **Configuration** > **MultiSafepay** > **General Settings** > **Send the order confirmation email**.
3. Choose one of these three options:
- On transaction completed status
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
- On transaction initialized status
- Immediately after placing the order

</details>

## Order lifetimes

The default lifetime of **Pending payment** orders in Magento 2 is 480 minutes (8 hours). For payment methods with a longer authorization period, the <<glossary:order status changes>> to **Cancelled** after 8 hours.
Expand Down Expand Up @@ -418,6 +435,20 @@ You cannot add payment links to order confirmation emails created in your **fron

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="activate-payment-methods">
<summary>How to activate payment methods</summary>
<br>

1. Sign in to your Magento 2 <<glossary:backend>>.
2. Go to **Stores** > **Configuration** > **MultiSafepay** > **Payment Gateways**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go to Stores > Configuration > MultiSafepay > Payment Gateways.
Or
Go to Stores > Configuration > MultiSafepay > Giftcards.

3. Choose the relevant payment method from the list and click **Configure**.
4. Set **Enabled** to **Yes**.
5. Click **Save Config**.

</details>

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down Expand Up @@ -621,7 +652,12 @@ _Tip_: This issue might appear after upgrading to our latest plugin version, pos

To debug this issue on your side:

1. Set to debug mode.
1. Set to debug mode. To activate debug mode:
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved

- Sign in to your Magento <<glossary:backend>>.
- Go to **Stores** > **Configuration** > **MultiSafepay** > **General settings** > **Enable debug mode**.
- Set to **Yes**.

2. Use our <a href="https://github.com/MultiSafepay/magento2-order-save-inspector" target="_blank">Order Save Inspector</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i> to check which module might interfere (for example, delivery software, ERP).
</details>

Expand Down
2 changes: 2 additions & 0 deletions content/integrations/odoo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ Supported since release: 1.1.0, July 2nd 2021.

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/opencart-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,8 @@ The customer receives the payment link in the email sent by OpenCart containing

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/opencart-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ If you're new to accepting card payments, email a request to activate them to <r

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/oscommerce.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ Release date: Mar 28, 2014

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
114 changes: 77 additions & 37 deletions content/integrations/prestashop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,43 @@ After completing the configuration, enable specific countries to make the paymen

# User guide

## Order flows

The plugin supports two flows for creating orders: **before** or **after** the transaction is completed.

<details id="before-flow">
<summary>Before flow</summary>
<br>

By default, order confirmation emails are sent before the payment is finalized.
You can disable this feature.

The status of abandoned payments changes to **Cancelled**.

</details>

<details id="after-flow">
<summary>After flow</summary>
<br>

Orders are created via a MultiSafepay notification to PrestaShop using the `cart ID`. After completing payment, the customer is redirected to your order confirmation page.
If the notification hasn't been processed yet, a waiting page with a loader displays while the order is created.

</details>

<details id="how-to-switch-order-flows">
<summary>How to switch order flows</summary>
<br>

To change the flow you are using, follow these steps:

1. Sign in to your PrestaShop Back Office.
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
2. Go to **MultiSafepay** > **General settings** tab.
3. In the **Create order before payment** field, select the flow.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

There are now available flows to select. You can only Enable/Disable

4. Click **Save**.

</details>

## Backend orders

In the previous release, PrestaShop Back Office orders were only created for MultiSafepay orders with **Completed** status.
Expand Down Expand Up @@ -108,43 +145,6 @@ You can filter payment methods by:

</details>

## Order flows

The plugin supports two flows for creating orders: **before** or **after** the transaction is completed.

<details id="before-flow">
<summary>Before flow</summary>
<br>

By default, order confirmation emails are sent before the payment is finalized.
You can disable this feature.

The status of abandoned payments changes to **Cancelled**.

</details>

<details id="after-flow">
<summary>After flow</summary>
<br>

Orders are created via a MultiSafepay notification to PrestaShop using the `cart ID`. After completing payment, the customer is redirected to your order confirmation page.
If the notification hasn't been processed yet, a waiting page with a loader displays while the order is created.

</details>

<details id="how-to-switch-order-flows">
<summary>How to switch order flows</summary>
<br>

To change the flow you are using, follow these steps:

1. Sign in to your PrestaShop Back Office.
2. Go to **MultiSafepay** > **General settings** tab.
3. In the **Create order before payment** field, select the flow.
4. Click **Save**.

</details>

## Payment components

The plugin supports [payment components](/docs/payment-components/), which:
Expand Down Expand Up @@ -198,6 +198,21 @@ The plugin supports [payment components](/docs/payment-components/), which:

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="activate-payment-methods">
<summary>How to activate payment methods</summary>
<br>

1. Sign in to your **PrestaShop** Back Office.
2. Go to **MultiSafepay** > **Payment Methods**.
3. Go to the relevant payment method and click **+**. This will show settings for the specific payment method.
4. Click to enable.

**💡 Tip!** You can handle the positioning of payment methods in the checkout by clicking the **left icon** and dragging it up or down.
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved

</details>

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down Expand Up @@ -361,6 +376,31 @@ If upgrading from 5.x to a newer version, see [Updates](/docs/prestashop-1-7#upd

---

## Troubleshooting

<details id="how-to-activate-debug-mode">
<summary>How to activate debug mode</summary>
<br>

1. Sign in to your **PrestaShop** Back Office.
2. Go to **MultiSafepay** > **General Settings** > **Debug mode**.
3. Click to enable.

</details>

<details id="how-to-get-a-system-report">
<summary>How to get a system report</summary>
<br>

1. Sign in to your **PrestaShop** Back Office.
2. Go to **MultiSafepay** > **General Settings** > **System Status**.
3. Click **Get system report**
4. A window will appear with the report. You can copy paste the content.
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved

</details>

---

[block:html]
{
"html": "<blockquote class=\"callout callout_info\">\n<h3 class=\"callout-heading false\">\n <span class=\"callout-icon\">💬</span>\n <p>Support</p>\n </h3>\n <p>Contact MultiSafepay:</p>\n <ul>\n <li>Telephone: <a href=\"tel:+310208500500\">+31 (0)20 8500 500</a></li>\n <li>Email: <a href=\"mailto:[email protected]\">[email protected]</a></li>\n <li>GitHub: <a href=\"https://github.com/MultiSafepay/prestashop-official/issues\" target=\"_blank\"> create a technical issue</a></li>\n </ul> \n</blockquote>"
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/pwa-studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ slug: 'pwa-studio-venia'

# Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

By default, this plugin supports all [payment methods supported by our Magento 2 plugin](/docs/magento-2#payment-methods) out of the box, except:
- Alipay+ ™ Partner
- Amazon Pay
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/scandipwa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ slug: 'scandipwa'

# Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/shopify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ For more information, see Shopify.dev – <a href="https://shopify.dev/apps/paym

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/shopware-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ To change the flow you are using, follow these steps:

### Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

By default, activated payment methods from your MultiSafepay account appear on the payment method list.

<details id="supported-payment-methods">
Expand Down
25 changes: 25 additions & 0 deletions content/integrations/shopware-6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ slug: 'shopware-6'
### Marketplace installation
Get the free MultiSafepay plugin from the <a href="https://store.shopware.com/en/mltis59465832976f/multisafepay-online-payments-for-shopware-ideal-cards-klarna-alipay-etc..html" target="_blank">Shopware 6 marketplace</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i> and connect your webshop with your Shopware account.

### Configuration

1. Sign in to your Shopware 6 <<glossary:backend>>.
2. Go to **Extensions** > **My extensions**.
3. In the **MultiSafepay** module, click **⋯** > **Configure**.
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
4. Set the environment to **Test** or **Live**.
5. In the **API key** field, enter your <a href="https://docs.multisafepay.com/docs/sites#site-id-api-key-and-security-code" target="_blank">API key</a> <i class="fa fa-external-link" style="font-size:12px;color:#8b929e"></i> and click **Validate API credentials**.
6. Click **Save**.

### Composer installation
Run the following command in the root of your Shopware root directory. Make sure the composer is installed on your hosting server.

Expand Down Expand Up @@ -86,6 +95,22 @@ For questions, email <[email protected]>

### Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="activate-payment-methods">
<summary>How to activate payment methods</summary>
<br>

1. Sign in to your Shopware 6 <<glossary:backend>>.
2. Go to **Settings** > **Payment Methods**.
3. Filter the relevant payment methods that have been activated in your MultiSafepay dashboard, e.g.,
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
JesseSnnt marked this conversation as resolved.
Show resolved Hide resolved
Mastercard | MultiSafepay module for Shopware 6.
4. Click **Activate**.

**💡 Tip!** You can handle the positioning of payment methods in the checkout by clicking **Edit display order in checkout**.

</details>

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/virtuemart-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ If a customer selects Apple Pay at checkout but isn't on an Apple device, they r

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
2 changes: 2 additions & 0 deletions content/integrations/virtuemart-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ If a customer selects Apple Pay at checkout but isn't on an Apple device, they r

## Payment methods

Before activating the relevant payment methods in your <<glossary:backend>>, you must first activate them in your MultiSafepay dashboard. See - [How to activate payment methods](/docs/payment-methods#activation).

<details id="supported-payment-methods">
<summary>Supported payment methods</summary>
<br>
Expand Down
Loading
Loading