diff --git a/CHANGELOG.md b/CHANGELOG.md index 13bc16b..0358130 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -148,7 +148,7 @@ - Added settings to control update of webhooks and payment methods # 4.0.15 -- Adjust VRPay/SW6 documentation - how to do refunds +- Adjust VR Payment/SW6 documentation - how to do refunds # 4.0.14 - Support for Shopware 6.4.6 diff --git a/CHANGELOG_de-DE.md b/CHANGELOG_de-DE.md index 21d58a6..d642447 100644 --- a/CHANGELOG_de-DE.md +++ b/CHANGELOG_de-DE.md @@ -146,7 +146,7 @@ - Einstellungen zur Steuerung der Aktualisierung von Webhooks und Zahlungsmethoden hinzugefügt # 4.0.15 -- VRPay/SW6-Dokumentation anpassen – wie man Rückerstattungen durchführt +- VR Payment/SW6-Dokumentation anpassen – wie man Rückerstattungen durchführt # 4.0.14 - Unterstützung für Shopware 6.4.6 diff --git a/README.md b/README.md index 7e1d57d..d2538e6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -VRPayment Payment for Shopware 6 +VR Payment Integration for Shopware 6 ============================= -The VRPayment Payment plugin wraps around the VRPayment API. This library facilitates your interaction with various services such as transactions. +The VR Payment plugin wraps around the VR Payment API. This library facilitates your interaction with various services such as transactions. Please note that this plugin is for versions 6.5 and 6.6. For the 6.4 plugin please visit [our Shopware 6.4 plugin](https://github.com/vr-payment/shopware-6-4). ## Requirements @@ -55,13 +55,13 @@ Uncompress the zip file you download, and include the autoloader in your project # unzip to ShopwareInstallDir/custom/plugins/VRPaymentPayment # For versions 6.1.10 and older, the SDK is installed automatically when installing the plugin in the shop, so you don't need to # run the following command. -composer require vrpayment/sdk 4.6.0 +composer require vrpayment/sdk 4.8.0 php bin/console plugin:refresh php bin/console plugin:install --activate --clearCache VRPaymentPayment ``` ## Usage -The library needs to be configured with your account's space id, user id, and application key which are available in your VRPayment +The library needs to be configured with your account's space id, user id, and application key which are available in your VR Payment account dashboard. ### Logs and debugging diff --git a/composer.json b/composer.json index 77de7a4..a3b5ac5 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "authors": [ { "homepage": "https://www.vr-payment.de/", - "name": "VRPay" + "name": "VR Payment" } ], "autoload": { @@ -12,7 +12,7 @@ }, "description": "VRPayment integration for Shopware 6", "extra": { - "copyright": "(c) by VRPay", + "copyright": "(c) by VR Payment", "description": { "de-DE": "VRPayment integration für Shopware 6", "en-GB": "VRPayment integration for Shopware 6", @@ -41,7 +41,7 @@ }, "homepage": "https://www.vr-payment.de//", "keywords": [ - "VRPay", + "VR Payment", "payment", "php", "shopware" diff --git a/docs/en/documentation.html b/docs/en/documentation.html index 5aac41a..d81b068 100644 --- a/docs/en/documentation.html +++ b/docs/en/documentation.html @@ -4,16 +4,16 @@ - + - VRPay Shopware 6 Documentation + VR Payment Shopware 6 Documentation
-

VRPay Shopware 6 Documentation

+

VR Payment Shopware 6 Documentation

Documentation

-

If you don’t already have one, create a VRPay account.

+

If you don’t already have one, create a VR Payment account.

@@ -76,7 +76,7 @@ You also have the possibility to install the plugin using composer. See
  • -

    Activate the VRPay Payment plugin from the Plugin Manager.

    +

    Activate the VR Payment Payment plugin from the Plugin Manager.

    • @@ -89,7 +89,7 @@ You also have the possibility to install the plugin using composer. See
    1. -

      Navigate to Settings → Plugins → VRPayment in your Shopware backend. Enter the VRPay Space ID, User ID and Authentication Key that you can create an application user.

      +

      Navigate to Settings → Plugins → VRPayment in your Shopware backend. Enter the VR Payment Space ID, User ID and Authentication Key that you can create an application user.

      plugin configuration @@ -119,7 +119,7 @@ You also have the possibility to install the plugin using composer. See
      -

      The VRPay payment method configurations are synchronized automatically into the Shopware store. There are just a few payment method settings in the Shopware store in Settings → Store → Payment.

      +

      The VR Payment payment method configurations are synchronized automatically into the Shopware store. There are just a few payment method settings in the Shopware store in Settings → Store → Payment.

      payment method configuration @@ -201,11 +201,11 @@ Billing address: Country | Is one of | Switzerland

      -

      The Payment Process of VRPay is completely standardized for every payment method you can process. This gives you the ability to simply add -a payment method or processor without changes inside of your Shopware configuration. An overview about the states and the payment processes of VRPay +

      The Payment Process of VR Payment is completely standardized for every payment method you can process. This gives you the ability to simply add +a payment method or processor without changes inside of your Shopware configuration. An overview about the states and the payment processes of VR Payment can be found in the Payment Documentation.

      -

      In the following section we provide you an overview about how the VRPay states are mapped into the Shopware State graph for orders and payment states.

      +

      In the following section we provide you an overview about how the VR Payment states are mapped into the Shopware State graph for orders and payment states.

      @@ -239,7 +239,7 @@ can be found in the
      1. -

        If the transaction is Authorized in VRPay, the Shopware order payment status is marked as In Progress.

        +

        If the transaction is Authorized in VR Payment, the Shopware order payment status is marked as In Progress.

      2. If the transaction fails before or during the authorization process, the Shopware order payment status is marked as Failed.

        @@ -248,7 +248,7 @@ can be found in the         @@ -276,10 +276,10 @@ can be found in the
        1. -

          If the transaction is Confirmed status in VRPay, the Shopware order delivery status is marked as Hold.

          +

          If the transaction is Confirmed status in VR Payment, the Shopware order delivery status is marked as Hold.

        2. -

          If the transaction in VRPay is marked as Fulfill, the Shopware order delivery status is marked as Open.

          +

          If the transaction in VR Payment is marked as Fulfill, the Shopware order delivery status is marked as Open.

        3. If the transaction is in Decline, Failed or Voided, the Shopware order delivery status is marked as Cancelled.

          @@ -295,7 +295,7 @@ can be found in the

          You can capture, cancel and refund transactions directly from within the Shopware backend. Please note -if you refund, void or capture transactions inside VRPay the events will be synchronized into +if you refund, void or capture transactions inside VR Payment the events will be synchronized into Shopware. However, there are some limitations (see below).

          @@ -314,7 +314,7 @@ Shopware. However, there are some limitations (see below).

          Note
          -When the completion is pending in VRPay the order will stay in pending state. +When the completion is pending in VR Payment the order will stay in pending state. @@ -325,11 +325,11 @@ When the completion is pending in VRPay the order will stay in pending state.

          Deferred payment completion

          -

          Retailers often have the case that they want to authorize transactions only and start the fulfillment process once all items are shippable. This is also possible with VRPay.

          +

          Retailers often have the case that they want to authorize transactions only and start the fulfillment process once all items are shippable. This is also possible with VR Payment.

          However, certain processes should be followed. If you have configured payment completion to be deferred you should capture the transaction before you initiate the shipment as it can always happen that a completion fails. If you want to be sure that you do not ship items for which you have not been paid you should postpone the shipment until -the fulfill state is reached. Initially the transaction will be in the Authorized state in VRPay and In Progress in Shopware. If you want to start the fulfillment process make sure you initiate the completion process as described above. Once the completion was successful the order will switch into the Fulfill state in VRPay and into Paid state in Shopware. You can now start the fulfillment process.

          +the fulfill state is reached. Initially the transaction will be in the Authorized state in VR Payment and In Progress in Shopware. If you want to start the fulfillment process make sure you initiate the completion process as described above. Once the completion was successful the order will switch into the Fulfill state in VR Payment and into Paid state in Shopware. You can now start the fulfillment process.

      @@ -389,7 +389,7 @@ It can take some time until you see the refund in Shopware. Refunds will only be
      -

      The delivery should not be done whilst the delivery state is Hold. This happens when the transaction in VRPay +

      The delivery should not be done whilst the delivery state is Hold. This happens when the transaction in VR Payment has not reached the fulfill state.

      There are essentially two reasons why this can happen:

      @@ -400,7 +400,7 @@ has not reached the fulfill state.

    2. We are not able to tell if you should fulfill the order. The delivery decision is done automatically. If this does not happen -within the defined time frame, VRPay will generate a manual task which you should observe and follow the instructions.

      +within the defined time frame, VR Payment will generate a manual task which you should observe and follow the instructions.

      3. @@ -409,18 +409,18 @@ within the defined time frame, VRPay will generate a manual task which you shoul

      - 6.5Limitations of the synchronization between VRPay and Shopware

      + 6.5Limitations of the synchronization between VR Payment and Shopware
      -

      Please note that captures, voids and refunds done in VRPay are synchronized. However, there are some -limitations. Inside VRPay you are able to change the unit price and the quantity at once. This can not +

      Please note that captures, voids and refunds done in VR Payment are synchronized. However, there are some +limitations. Inside VR Payment you are able to change the unit price and the quantity at once. This can not be done in the Shopware backend. We therefore recommend that you -perform the refunds always inside the Shopware backend and not inside VRPay. If a refund +perform the refunds always inside the Shopware backend and not inside VR Payment. If a refund cannot be synchronized it will be sent to the processor but it could be that you do not see it inside your Shopware backend.

      -

      You can find more information about Refunds in VRPay in our Refund Documentation.

      +

      You can find more information about Refunds in VR Payment in our Refund Documentation.

      @@ -482,7 +482,7 @@ The extension will log various unexpected errors or information which can help i
      -

      Make sure that you followed the Configuration section by stating your VRPay space ID and application user’s access information in the Shopware backend. By saving the configuration form the synchronization of the payment methods and the set up of the webhooks are initiated.

      +

      Make sure that you followed the Configuration section by stating your VR Payment space ID and application user’s access information in the Shopware backend. By saving the configuration form the synchronization of the payment methods and the set up of the webhooks are initiated.

      If this does not solve the problem, it could be that you use a special fee or coupon module that we do not support. Try to disable this plugin and see if it helps. The payment methods are only displayed if the plugin’s total calculation matches the actual order total.

      @@ -637,7 +637,7 @@ The Webhooks have to be updated. Shopware is using an API Version for all "URLs"
    3. 6.5 - Limitations of the synchronization between VRPay and Shopware + Limitations of the synchronization between VR Payment and Shopware