Skip to content
This repository was archived by the owner on Jan 25, 2024. It is now read-only.

Commit 777925b

Browse files
committed
Release 1.0.0
1 parent 4da0044 commit 777925b

File tree

467 files changed

+122186
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

467 files changed

+122186
-0
lines changed

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

README.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Opencart 2.0 Wallee Integration BETA
2+
This repository contains the Opencart wallee payment module that enables the shop to process payments with [wallee](https://wallee.com/).
3+
4+
##### To use this extension, a [wallee](https://wallee.com/) account is required.
5+
6+
## Requirements
7+
8+
* [Opencart](https://www.opencart.com/) 2.0.x
9+
* [PHP](http://php.net/) 5.4 or later
10+
11+
## Documentation
12+
13+
### Prerequisites
14+
15+
1. If you don't already have one, create a [wallee](https://app-wallee.com/user/signup) account, set up a space and sign up for an OpenCart account.
16+
2. Create an application user that is allowed to access the space you want to link to the OpenCart store. Navigate to your wallee account > application user and create your application user. The user ID and the authentication key will be shown to you.
17+
18+
![Application user configuration](screenshots/application_user.png)
19+
20+
3. Make sure that you grant the application users the necessary rights (Account Admin) in order to configure the webhooks, payment methods etc. out of your Opencart store.
21+
4. Setup at least one each of processor, payment method and connector configuration. More information about the [processor concept](https://app-wallee.com/doc/payment) can be found in the documentation.
22+
23+
### Installation
24+
25+
#### Manual installation
26+
27+
The easiest way to install the plugin is by uploading the files directly.
28+
29+
1. Upload the contents of the upload folder to the store's root directory using FTP/SSH.
30+
2. The plugin will now be visible under your **Payments**. You can install the plugin directly from here. After the plugin is installed, you can open the configuration.
31+
32+
#### Extension installer
33+
34+
The plugin can also be installed using OpenCarts **Extension Installer**.
35+
36+
1. Compress the upload folder to a ZIP file.
37+
2. Rename the file extension from .zip to .ocmod.zip
38+
3. Open the **Extension Installer** in your OpenCart backend
39+
4. Upload the zipped directory using the **Extension Installer**
40+
5. The plugin will now be visible under your **Payments**. You can install the plugin directly from here. After the plugin is installed, you can open the configuration.
41+
42+
### Configuration
43+
44+
1. Open the extensions configuration page
45+
2. Enter the User ID, Application User Key and Space ID
46+
3. Configure the status mapping so it matches. The defaults should be correct, but may differ depending on your workflow, or any custom statusses already in use. Check our [transaction states](https://app-wallee.com/en-us/doc/payment/transaction-process) page for more information.
47+
4. Set if you want invoices and packing slips to be available to the customer from the OpenCart frontend.
48+
4. Save the configuration
49+
5. Refresh modifications
50+
51+
The extension will automatically configure itself and create all required files after completing these steps. Payment methods and webhooks are registered automatically and will be available in the store.
52+
53+
If you have configured a separate currency to have a non-1.00 value please be aware that there may be rounding errors due to the way OpenCart handles currency totals and taxes.
54+
55+
Note that webhooks will not arrive if maintenance mode is active. This results in orders not being completed.
56+
57+
![Application user configuration](screenshots/settings.png)
58+
59+
## Features
60+
61+
### Payment methods & webhooks
62+
63+
The extension will pull any configured payment methods and webhooks from your wallee account. Note: The payment methods will not appear in the payment overview of your OpenCart backend.
64+
65+
### Packing slips & invoices
66+
67+
You may allow customers to download their own packing slips and / or invoices. This can be configured in the extension settings page. The download buttons are available in the customers order view. The documents are made available in the PDF format.
68+
69+
![Packing slips & invoices](screenshots/download.png)
70+
71+
### Refunds
72+
73+
The extension allows transactions made with it to also be refunded directly from the opencart backend if the transaction is in the correct state.
74+
75+
![Refund](screenshots/refund.png)
76+
77+
### Completion
78+
79+
Orders can be processed in two steps depending on your wallee configurations. In the case of manual completions the order stays in a reserved state until the merchant confirms that the funds should be transferred. A completion can be initiated from the order view in your OpenCart backend if the transaction is in the correct state.
80+
81+
### Void
82+
83+
Orders which are processed in two steps can be voided instead of completed. A void can be initiated from the order view in your OpenCart backend if the transaction is in the correct state.
84+
85+
### Alerts
86+
87+
If there are open manual tasks in your wallee account, or if a non-synchronous task such as a void, completion or refund fails, this information is displayed in your OpenCart backend.
88+
89+
![Alerts](screenshots/alerts.png)
90+
91+
### Transaction Information
92+
93+
Most information regarding the transaction can be directly viewed from the OpenCart backend. This includes any configured labels, invoices and packing slips. If there have been any completions, voids or refunds initiated from the OpenCart backend these will also be visible.
94+
95+
![Transaction Information](screenshots/transaction.png)
96+
97+
### Further information
98+
99+
Have a look at our documentation to get to know wallee in more details. There are a lot of interesting features that could be beneficial to you and save you a lot of money and time in your daily operations. Below there is just a list of the most important and most used features.
100+
101+
* [ESR Orange Einzahlungsscheine](https://wallee.com/features/esr.html)
102+
* [Document Templates](https://wallee.com/features/document-handling.html)
103+
* [Integrated Processors](https://app-wallee.com/en/processors)
104+
* [E-Mail Templates](https://wallee.com/features/document-handling.html)
105+
* [Cloud Printing](https://wallee.com/features/cloud-printing.html)
106+
* [Payment Routing](https://wallee.com/features/intelligent-payment-routing.html)
107+
108+
### Support
109+
110+
If you have questions use the support form in your space or use the [online form](https://wallee.com/support.html).
111+
112+
## License
113+
114+
Please see the [license file](./LICENSE) for more information.
115+
116+
## Other Opencart Versions
117+
118+
Find the module for different Opencart versions [here](https://github.com/wallee-payment/openc

screenshots/alerts.png

107 KB
Loading

screenshots/application_user.png

68.8 KB
Loading

screenshots/download.png

52.9 KB
Loading

screenshots/refund.png

22.8 KB
Loading

screenshots/settings.png

59.8 KB
Loading

screenshots/transaction.png

78.9 KB
Loading
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?php
2+
require_once modification(DIR_SYSTEM . 'library/wallee/helper.php');
3+
4+
/**
5+
* Handles the display of alerts in the top right.
6+
* Is used in combination with
7+
* - model/extension/wallee/alert.php
8+
* - system/library/wallee/modification/WalleeAlerts.ocmod.xml
9+
*/
10+
class ControllerExtensionWalleeAlert extends Wallee\Controller\AbstractEvent {
11+
12+
/**
13+
* Redirects the user to the manual task overview in the wallee backend.
14+
*/
15+
public function manual(){
16+
try {
17+
$this->validate();
18+
$this->response->redirect(\WalleeHelper::getBaseUrl() . '/s/' . $this->config->get('wallee_space_id') . '/manual-task/list');
19+
}
20+
catch (Exception $e) {
21+
$this->displayError($e->getMessage());
22+
}
23+
}
24+
25+
/**
26+
* Redirect the user to the order with the oldest checkable failed job.
27+
*/
28+
public function failed(){
29+
try {
30+
$oldest_failed = \Wallee\Entity\RefundJob::loadOldestCheckable($this->registry);
31+
if (!$oldest_failed->getId()) {
32+
$oldest_failed = \Wallee\Entity\CompletionJob::loadOldestCheckable($this->registry);
33+
}
34+
if (!$oldest_failed->getId()) {
35+
$oldest_failed = \Wallee\Entity\VoidJob::loadOldestCheckable($this->registry);
36+
}
37+
$this->response->redirect(
38+
$this->createUrl('sale/order/info',
39+
array(
40+
\WalleeVersionHelper::TOKEN => $this->session->data[\WalleeVersionHelper::TOKEN],
41+
'order_id' => $oldest_failed->getOrderId()
42+
)));
43+
}
44+
catch (Exception $e) {
45+
$this->displayError($e->getMessage());
46+
}
47+
}
48+
49+
protected function getRequiredPermission(){
50+
return 'extension/wallee/alert';
51+
}
52+
}

0 commit comments

Comments
 (0)