vr-payment/archived-shopware-6
1
0
Fork 0
mirror of https://github.com/vr-payment/shopware-6.git synced 2026-06-04 10:53:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 6.1.12

Browse Source
This commit is contained in:
andrewrowanwallee
2025-03-26 11:59:32 +01:00
parent 3f291ef7ea
commit 2cba2a8f3e
5 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/documentation.html
+27 -27
View File
@@ -4,16 +4,16 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="keywords" value="VRPay, Shopware, Shopware Plugin, Payment, Payment Integration, Documentation"><meta name="description" value="The documentation for the Shopware 6 plugin that enables processing payments with VRPay.">
<meta name="keywords" value="VR Payment, Shopware, Shopware Plugin, Payment, Payment Integration, Documentation"><meta name="description" value="The documentation for the Shopware 6 plugin that enables processing payments with VR Payment.">
<link rel="canonical" href="https://plugin-documentation.wallee.com/wallee-payment/shopware-6/master/VRPaymentPayment/docs/en/documentation.html" />
<title>VRPay Shopware 6 Documentation</title>
<title>VR Payment Shopware 6 Documentation</title>
<link href="assets/monokai-sublime.css" rel="stylesheet" />
<link href="assets/base.css" rel="stylesheet" />
</head>
<body class="documentation">
<div class="layout-wrapper">
<div class="layout-title">
<h1>VRPay Shopware 6 Documentation</h1>
<h1>VR Payment Shopware 6 Documentation</h1>
<h2>Documentation</h2> </div>
<div class="layout-navigation">
<ul class="nav">
@@ -39,7 +39,7 @@
</div>
<div class="chapter-body">
<div class="paragraph">
<p>If you don&#8217;t already have one, create a <a href="https://gateway.vr-payment.de/user/login/">VRPay</a> account.</p>
<p>If you don&#8217;t already have one, create a <a href="https://gateway.vr-payment.de/user/login/">VR Payment</a> account.</p>
</div> </div>
</div> <div class="chapter" id="_installation">
<div class="chapter-title">
@@ -76,7 +76,7 @@ You also have the possibility to install the plugin using composer. See <a href
</div>
</li>
<li>
<p>Activate the VRPay Payment plugin from the Plugin Manager.</p>
<p>Activate the VR Payment Payment plugin from the Plugin Manager.</p>
</li>
</ol>
</div> </div>
@@ -89,7 +89,7 @@ You also have the possibility to install the plugin using composer. See <a href
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Navigate to Settings &#8594; Plugins &#8594; VRPayment in your Shopware backend. Enter the VRPay Space ID, User ID and Authentication Key that you can create an <a href="https://gateway.vr-payment.de/en-us/doc/permission-concept#_create_application_users" target="_blank">application user</a>.</p>
<p>Navigate to Settings &#8594; Plugins &#8594; VRPayment in your Shopware backend. Enter the VR Payment Space ID, User ID and Authentication Key that you can create an <a href="https://gateway.vr-payment.de/en-us/doc/permission-concept#_create_application_users" target="_blank">application user</a>.</p>
<div class="imageblock">
<div class="content">
<img src="resource/plugin-configuration.png" alt="plugin configuration"/>
@@ -119,7 +119,7 @@ You also have the possibility to install the plugin using composer. See <a href
</div>
<div class="section-body">
<div class="paragraph">
<p>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 &#8594; Store &#8594; Payment.</p>
<p>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 &#8594; Store &#8594; Payment.</p>
</div><div class="imageblock">
<div class="content">
<img src="resource/payment-method-configuration.png" alt="payment method configuration"/>
@@ -201,11 +201,11 @@ Billing address: Country | Is one of | Switzerland</p>
</div>
<div class="chapter-body">
<div class="paragraph">
<p>The Payment Process of VRPay is <strong>completely standardized for every payment method</strong> 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
<p>The Payment Process of VR Payment is <strong>completely standardized for every payment method</strong> 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 <a href="https://gateway.vr-payment.de/en-us/doc/payment/transaction-process" target="_blank">Payment Documentation</a>.</p>
</div><div class="paragraph">
<p>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.</p>
<p>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.</p>
</div> <div class="section" id="_state_mapping_of_shopware_orders">
<div class="section-title">
<h2>
@@ -239,7 +239,7 @@ can be found in the <a href="https://gateway.vr-payment.de/en-us/doc/payment/tra
</div><div class="olist glossary">
<ol class="glossary">
<li>
<p>If the transaction is <code>Authorized</code> in VRPay, the Shopware order payment status is marked as <code>In Progress</code>.</p>
<p>If the transaction is <code>Authorized</code> in VR Payment, the Shopware order payment status is marked as <code>In Progress</code>.</p>
</li>
<li>
<p>If the transaction fails before or during the authorization process, the Shopware order payment status is marked as <code>Failed</code>.</p>
@@ -248,7 +248,7 @@ can be found in the <a href="https://gateway.vr-payment.de/en-us/doc/payment/tra
<p>If the transaction fails after the authorization, the Shopware order payment status is marked as <code>Cancelled</code>.</p>
</li>
<li>
<p>If the transaction invoice in VRPay is marked as <code>Paid</code> or <code>Not Applicable</code>, the Shopware order payment status is marked as <code>Paid</code>.</p>
<p>If the transaction invoice in VR Payment is marked as <code>Paid</code> or <code>Not Applicable</code>, the Shopware order payment status is marked as <code>Paid</code>.</p>
</li>
</ol>
</div> <div class="section" id="_general_remarks_regarding_payment_statuses">
@@ -276,10 +276,10 @@ can be found in the <a href="https://gateway.vr-payment.de/en-us/doc/payment/tra
</div><div class="olist glossary">
<ol class="glossary">
<li>
<p>If the transaction is <code>Confirmed</code> status in VRPay, the Shopware order delivery status is marked as <code>Hold</code>.</p>
<p>If the transaction is <code>Confirmed</code> status in VR Payment, the Shopware order delivery status is marked as <code>Hold</code>.</p>
</li>
<li>
<p>If the transaction in VRPay is marked as <code>Fulfill</code>, the Shopware order delivery status is marked as <code>Open</code>.</p>
<p>If the transaction in VR Payment is marked as <code>Fulfill</code>, the Shopware order delivery status is marked as <code>Open</code>.</p>
</li>
<li>
<p>If the transaction is in <code>Decline</code>, <code>Failed</code> or <code>Voided</code>, the Shopware order delivery status is marked as <code>Cancelled</code>.</p>
@@ -295,7 +295,7 @@ can be found in the <a href="https://gateway.vr-payment.de/en-us/doc/payment/tra
<div class="chapter-body">
<div class="paragraph">
<p>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).</p>
</div> <div class="section" id="_complete_capture_an_order">
<div class="section-title">
@@ -314,7 +314,7 @@ Shopware. However, there are some limitations (see below).</p>
<div class="title">Note</div>
</td>
<td class="content">
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.
</td>
</tr>
</table>
@@ -325,11 +325,11 @@ When the completion is pending in VRPay the order will stay in pending state.
</div><div class="paragraph">
<p><strong>Deferred payment completion</strong></p>
</div><div class="paragraph">
<p>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.</p>
<p>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.</p>
</div><div class="paragraph">
<p>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 <code>Authorized</code> state in VRPay and <code>In Progress</code> 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 <code>Fulfill</code> state in VRPay and into <code>Paid</code> state in Shopware. You can now start the fulfillment process.</p>
the fulfill state is reached. Initially the transaction will be in the <code>Authorized</code> state in VR Payment and <code>In Progress</code> 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 <code>Fulfill</code> state in VR Payment and into <code>Paid</code> state in Shopware. You can now start the fulfillment process.</p>
</div> </div>
</div> <div class="section" id="_void_a_transaction">
<div class="section-title">
@@ -389,7 +389,7 @@ It can take some time until you see the refund in Shopware. Refunds will only be
</div>
<div class="section-body">
<div class="paragraph">
<p>The delivery should not be done whilst the delivery state is <code>Hold</code>. This happens when the transaction in VRPay
<p>The delivery should not be done whilst the delivery state is <code>Hold</code>. This happens when the transaction in VR Payment
has not reached the fulfill state.</p>
</div><div class="paragraph">
<p>There are essentially two reasons why this can happen:</p>
@@ -400,7 +400,7 @@ has not reached the fulfill state.</p>
</li>
<li>
<p>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.</p>
within the defined time frame, VR Payment will generate a manual task which you should observe and follow the instructions.</p>
</li>
</ul>
</div><div class="paragraph">
@@ -409,18 +409,18 @@ within the defined time frame, VRPay will generate a manual task which you shoul
</div> <div class="section" id="_limitations_of_the_synchronization_between_whitelabelname_and_shopware">
<div class="section-title">
<h2>
<span class="title-number">6.5</span>Limitations of the synchronization between VRPay and Shopware </h2>
<span class="title-number">6.5</span>Limitations of the synchronization between VR Payment and Shopware </h2>
</div>
<div class="section-body">
<div class="paragraph">
<p>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 <strong>unit price</strong> and the <strong>quantity</strong> at once. This can not
<p>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 <strong>unit price</strong> and the <strong>quantity</strong> 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.</p>
</div><div class="paragraph">
<p>You can find more information about Refunds in VRPay in our <a href="https://gateway.vr-payment.de/en-us/doc/payment/refund" target="_blank">Refund Documentation</a>.</p>
<p>You can find more information about Refunds in VR Payment in our <a href="https://gateway.vr-payment.de/en-us/doc/payment/refund" target="_blank">Refund Documentation</a>.</p>
</div> </div>
</div> <div class="section" id="_tokenization">
<div class="section-title">
@@ -482,7 +482,7 @@ The extension will log various unexpected errors or information which can help i
</div>
<div class="section-body">
<div class="paragraph">
<p>Make sure that you followed the <a href="#_configuration">Configuration</a> section by stating your VRPay space ID and application user&#8217;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.</p>
<p>Make sure that you followed the <a href="#_configuration">Configuration</a> section by stating your VR Payment space ID and application user&#8217;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.</p>
</div><div class="paragraph">
<p>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&#8217;s total calculation matches the actual order total.</p>
@@ -637,7 +637,7 @@ The Webhooks have to be updated. Shopware is using an API Version for all "URLs"
</li> <li class="nav-level-2">
<a href="#_limitations_of_the_synchronization_between_whitelabelname_and_shopware">
<span class="item-number">6.5</span>
<span class="item-title">Limitations of the synchronization between VRPay and Shopware</span>
<span class="item-title">Limitations of the synchronization between VR Payment and Shopware</span>
</a>
</li> <li class="nav-level-2">
<a href="#_tokenization">