Skip to content

Commit 9554e1e

Browse files
aschemppaschempp
committed
Added Stripe Payments
1 parent 84bc089 commit 9554e1e

File tree

13 files changed

+253
-0
lines changed

13 files changed

+253
-0
lines changed

‎docs/payment-stripe/_index.de.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Stripe Zahlungen für Isotope eCommerce"
3+
---
4+
5+
# Stripe Zahlungen für Isotope eCommerce
6+
7+
Mit dieser Erweiterung kannst du den Zahlungsanbieter [Stripe](https://www.stripe.com)
8+
in deinem Isotope eCommerce Shop verwenden.
9+
10+
11+
## Vorteile
12+
13+
- _Stripe Payments_ vereinheitlicht die Abwicklung von [über 100 Zahlungsmittel][Payments] wie
14+
Kreditkarte (VISA, MasterCard), PayPal, ApplePay, Klarna und viele mehr.
15+
16+
- Die Auswahl der Zahlungsmittel erfolgt entweder auf Seite von Stripe (automatisches Angebot)
17+
abhängig vom Kunden, oder kann in der Zahlungsmethode in Isotope konfiguriert werden. [Siehe Zahlungsmittel][payment_types]
18+
19+
- Durch Webhooks werden erfolgreiche Zahlungen sichergestellt, auch wenn Kund:innen
20+
den Bestellprozess z.B. nach Abschluss bei PayPal verlassen. [Siehe Webhooks][webhooks]
21+
22+
23+
[Payments]: https://stripe.com/de-ch/payments/payment-methods
24+
[payment_types]: ./einrichtung#zahlungsarten
25+
[webhooks]: ./webhooks

‎docs/payment-stripe/_index.en.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Stripe payments for Isotope eCommerce"
3+
---
4+
5+
# Stripe payments for Isotope eCommerce
6+
7+
With this extension you can use the payment provider [Stripe](https://www.stripe.com)
8+
in your Isotope eCommerce Shop.
9+
10+
11+
## Advantages
12+
13+
- _Stripe Payments_ standardizes the processing of [over 100 payment methods][Payments] such as
14+
credit card (VISA, MasterCard), PayPal, ApplePay, Klarna and many more.
15+
16+
- The means of payment is selected either on the Stripe side (automatic offer)
17+
depending on the customer, or can be configured in the payment method in Isotope. [See means of payment][payment_types]
18+
19+
- Webhooks ensure successful payments, even if customers leave the order process,
20+
e.g. after completing it with PayPal. [See webhooks][webhooks]
21+
22+
23+
[Payments]: https://stripe.com/de-ch/payments/payment-methods
24+
[payment_types]: ./configuration#zahlungsarten
25+
[webhooks]: ./webhooks

‎docs/payment-stripe/configuration/_index.de.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: "Einrichtung"
3+
url: "einrichtung"
4+
weight: 100
5+
---
6+
7+
Nach erfolgreicher Installation der Erweiterung steht im Backend
8+
von Isotope eCommerce eine neue Zahlungsart zur Verfügung. Diese
9+
kann über den Punkt _Shop-Konfiguration_ => _Zahlungsarten_ eingerichtet werden.
10+
11+
![](backend.de.png)
12+
13+
14+
## Einrichtung der Zugangsdaten
15+
16+
Für die Verbindung mit Stripe werden API-Zugangsdaten (öffentlicher und geheimer Schlüssel)
17+
benötigt. Diese können im Stripe-Benutzerkonto unter _Developers_ gefunden werden.
18+
Beide Schlüssel müssen ins Backend von Contao kopiert werden.
19+
20+
![](keys.png)
21+
22+
## Weitere Felder
23+
24+
### Beschreibung der Bestellung
25+
26+
Dieser Text wird bei Stripe angezeigt, wenn die Bestellung verarbeitet wird.
27+
Gib z.B. deinen Shop-Namen oder "Bestellung von xxx" ein. Diese Zeile wird benötigt,
28+
da Stripe keine negativen Produktdaten (Rabatte) darstellen kann.
29+
30+
31+
### Zahlungsarten
32+
33+
> Stripe zeigt deinen Kunden/Kundinnen dynamisch die relevantesten Zahlungsmethoden an,
34+
> basierend auf den im Dashboard festgelegten Präferenzen für die Zahlungsmethoden und
35+
> den Berechtigungsfaktoren wie Transaktionsbetrag, Währung und Zahlungsfluss.
36+
> – [Stripe Dokumentation](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods)
37+
38+
Im Feld _Zahlungsarten_ kann eine kommaseparierte Liste von Zahlungsmethoden eingegeben werden,
39+
falls nicht automatisch alle angeboten werden sollen. Siehe dazu die [Liste der möglichen Werte](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
40+
41+
### Transaktions-Typ
42+
43+
Hier kann gesteuert werden, ob Zahlungen z.B. bei Kreditkarten automatisch belastet
44+
oder nur reserviert werden. Im Normalfall ist "Authorisieren und Einnehmen" die sinnvollere Option.
45+
46+
### Erlaube verzögerte Zahlungsmittel
47+
48+
Standardmässig werden Bestellungen in Isotope nur abgeschlossen, wenn die Zahlung erfolgreich ist,
49+
z.B. wenn die Kreditkarte erfolgreich belastet werden konnte. Stripe unterstützt allerdings auch
50+
Zahlungsmittel, welche erst verzögert erfolgreich sind. Dazu gehören zum Beispiel _SEPA-Lastschrift_
51+
oder _Banküberweisung_.
52+
53+
Wird die entsprechende Option aktiviert, prüft die Zahlungsmethode nicht mehr auf Erfolg der Zahlung.
54+
Die Bestellung wird sofort abgeschlossen, ob die Bestellung versendet werden soll, muss manuell geprüft werden.
55+
56+
{{% notice warning %}}
57+
Wenn verzögerte Zahlungsmittel verwendet werden, sollte ein Bestellstatus gewählt werden,
58+
der nicht sofort als _bezahlt_ gilt. Ansonsten ist es möglich, z.B. digitale Artikel wie PDFs herunterzuladen,
59+
bevor die Zahlung tatsächlich erfolgreich ist.
60+
{{% /notice %}}

‎docs/payment-stripe/configuration/_index.en.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Configuration"
3+
url: "configuration"
4+
weight: 100
5+
---
6+
7+
After successfully installing the extension, a new payment method will appear in the backend
8+
of Isotope eCommerce. It can be set up by selecting _Store configuration_ => _Payment methods_.
9+
![](backend.en.png)
10+
11+
12+
## Setting up the access details
13+
14+
API access credentials (publishable and secret key) are required for the connection with Stripe.
15+
These can be found in the Stripe user account under _Developers_. Both keys must be copied into the Contao backend.
16+
17+
![](keys.png)
18+
19+
## Other fields
20+
21+
### Order Description
22+
23+
This text is displayed by Stripe in the payment processing screen.
24+
Enter your store name or "Order from xxx" for example. Unfortunately, this line
25+
is required, as Stripe cannot display negative product amounts (discounts).
26+
27+
28+
### Payment method types
29+
30+
> Stripe dynamically displays the most relevant payment methods to your customers based on the payment method
31+
> preferences you set in the Dashboard and eligibility factors such as transaction amount, currency, and payment flow.
32+
> – [Stripe documentation](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods)
33+
34+
A comma-separated list of payment methods can be entered in the _Payment method types_ field,
35+
if not all of them are to be offered automatically.
36+
See the [list of possible values](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
37+
38+
### Transaction type
39+
40+
Here you can control whether payments, e.g. for credit cards, are automatically debited
41+
or only reserved. Normally, "Authorize and collect" is the more sensible option.
42+
43+
### Allow delayed payment methods
44+
45+
By default, orders in Isotope are only completed if the payment is successful,
46+
e.g. when the credit card has been successfully charged. However, Stripe also supports
47+
payment methods that are only successful after a delay. These include _SEPA direct debit_
48+
or _bank transfer_ and others.
49+
50+
If the option is activated, the payment method no longer checks whether the payment was successful.
51+
The order is completed immediately, whether the order should be sent must be checked manually.
52+
53+
54+
{{% notice warning %}}
55+
If delayed means of payment are used, an order status should be selected that is not immediately considered _paid_.
56+
Otherwise, it might be possible to download digital items such as PDFs
57+
before the payment is actually successful.
58+
{{% /notice %}}

‎docs/payment-stripe/configuration/backend.de.png

235 KB
Loading

‎docs/payment-stripe/configuration/backend.en.png

225 KB
Loading

‎docs/payment-stripe/configuration/keys.png

96.8 KB
Loading

‎docs/payment-stripe/webhooks/_index.de.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Webhooks"
3+
url: "webhooks"
4+
weight: 200
5+
---
6+
7+
Durch die Einrichtung von Webhooks kann der Shop auf Ereignisse in deinem Stripe-Konto reagieren,
8+
um die korrekte Verarbeitung von Zahlungen sicherzustellen. Weitere Erklärungen findest
9+
du in der [Dokumentation von Stripe](https://docs.stripe.com/webhooks).
10+
11+
{{% notice info %}}
12+
**Für die Nutzung von Webhooks benötigtst du mindestens Version 1.0.0 der Erweiterung.**
13+
Beachte das Webhooks nicht auf lokalen Testsystemen funktionieren, oder wenn du
14+
deinen Shop mittels Passwort geschützt hast.
15+
{{% /notice %}}
16+
17+
18+
## Einrichtung bei Stripe
19+
20+
Registriere die URL des Webhook-Endpoints im Abschnitt [Webhooks](https://dashboard.stripe.com/webhooks)
21+
im Entwickler-Dashboard. Dadurch weiss Stripe, wohin Ereignisse übermittelt werden sollen.
22+
23+
Als _Event_ benötigt Isotope nur **checkout.session.completed**. Die **Endpoint-URL** findest du im Backend von Contao, wenn du die entsprechende Zahlungsmethode bearbeitest.
24+
Sie wird oben als Hinweis über dem Eingabeformular angezeigt.
25+
26+
27+
## Einrichtung bei Isotope
28+
29+
Für die Verarbeitung von Webhooks ist bei Isotope keine Anpassung nötig.
30+
Sobald die entsprechenden Meldungen von Stripe eingehen, werden diese
31+
vom Shop automatisch akzeptiert und falls nötig verarbeitet.

‎docs/payment-stripe/webhooks/_index.en.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Webhooks"
3+
url: "webhooks"
4+
weight: 200
5+
---
6+
7+
By setting up webhooks, your shop can react to events in your Stripe account
8+
to ensure the correct processing of payments. Further explanations can be found
9+
in the [Stripe documentation](https://docs.stripe.com/webhooks).
10+
11+
{{% notice info %}}
12+
**To use webhooks you need at least version 1.0.0 of the extension.**
13+
Note that webhooks do not work on local test systems, or if you have protected
14+
your store website with a password.
15+
{{% /notice %}}
16+
17+
18+
## Setting up Stripe
19+
20+
Register the URL of the webhook endpoint in the [Webhooks](https://dashboard.stripe.com/webhooks) section
21+
in the developer dashboard. This tells Stripe where events should be transmitted to.
22+
23+
As _event_ Isotope only needs **checkout.session.completed**. You can find the **Endpoint URL** in the Contao backend
24+
when you edit the corresponding payment method. It is displayed as a note above the input form.
25+
26+
27+
## Setting up Isotope
28+
29+
Isotope does not require any setup for processing webhooks.
30+
As soon as the corresponding messages are received from Stripe, they are
31+
automatically accepted by the store and processed if necessary.

‎page/config/payment-stripe/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
contentDir: '../docs/payment-stripe'
2+
title: 'Stripe Payments'
3+
defaultContentLanguageInSubdir: true
4+
DefaultContentLanguage: en
5+
6+
menu:
7+
shortcuts:
8+
-
9+
name: "<i class='fas fa-shopping-cart'></i> Extension Store"
10+
identifier: "ds"
11+
url: "https://extensions.terminal42.ch/p/payment-stripe"
12+
weight: 10

‎page/config/payment-stripe/languages.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
en:
2+
languageName: English
3+
weight: 1
4+
de:
5+
languageName: Deutsch
6+
weight: 2

‎page/config/payment-stripe/params.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
DocumentationTitleEn: Stripe Payments
2+
DocumentationTitleDe: Stripe Zahlungen
3+
extensionPermalink: https://extensions.terminal42.ch/p/payment-stripe
4+
extensionIcon: payment-stripe.svg

‎page/static/images/logos/payment-stripe.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)