Merge pull request #17 from heidelpay/develop

merge changes for version 1.2.0

config.json

@@ -321,6 +321,59 @@
           }
         }
       }
+    },
+    "Config.invoicesecuredb2cTab": {
+      "label": "Config.invoicesecuredb2cTab",
+      "formFields": {
+        "invoicesecuredb2c.isActive": {
+          "type": "checkBox",
+          "required": false,
+          "label": "Config.invoicesecuredb2cIsActiveLabel",
+          "options": {
+            "defaultValue": false
+          }
+        },
+        "invoicesecuredb2c.displayName": {
+          "type": "inputText",
+          "required": false,
+          "label": "Config.invoicesecuredb2cDisplayNameLabel",
+          "options": {
+            "defaultValue": "Gesicherter Rechnungskauf B2C"
+          }
+        },
+        "invoicesecuredb2c.channelId": {
+          "type": "inputText",
+          "required": false,
+          "label": "Config.invoicesecuredb2cChannelIdLabel",
+          "options": {
+            "defaultValue": "31HA07BC8129FBA7AF65934626B0F907"
+          }
+        },
+        "invoicesecuredb2c.minAmount": {
+          "type": "inputText",
+          "required": false,
+          "label": "Config.invoicesecuredb2cMinAmountLabel",
+          "options": {
+            "defaultValue": "0,00"
+          }
+        },
+        "invoicesecuredb2c.maxAmount": {
+          "type": "inputText",
+          "required": false,
+          "label": "Config.invoicesecuredb2cMaxAmountLabel",
+          "options": {
+            "defaultValue": "0,00"
+          }
+        },
+        "invoicesecuredb2c.iconUrl": {
+          "type": "inputText",
+          "required": false,
+          "label": "Config.invoicesecuredb2cIconUrl",
+          "options": {
+            "defaultValue": ""
+          }
+        }
+      }
     }
   }
 }

meta/documents/changelog_de.md

@@ -1,5 +1,19 @@
 # heidelpay Payment Gateway Changelog
 
+## [1.2.0][1.2.0]
+
+### Added
+- Zahlart ``gesicherter Rechnungskauf B2C`` hinzugefügt.
+- Daten-Container für zusätzliche Zahlungsinformationen ergänzt. [Siehe Beschreibung im User Guide.](user_guide_de.md)
+- Weiteres Vorschaubild hinzugefügt.
+- Warenkorbübertragung für gesicherte Zahlarten aktiviert.
+
+### Changed
+- User guides aktualisiert.
+
+### Removed
+- Veralteten code entfernt.
+
 ## [1.1.2][1.1.2]
 
 ### Fixed
@@ -39,4 +53,5 @@
 
 [1.1.0]: https://github.com/heidelpay/plentymarkets-gateway/tree/1.1.0
 [1.1.1]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.0..1.1.1
-[1.1.2]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.1..1.1.2
+[1.1.2]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.1..1.1.2
+[1.2.0]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.2..1.2.0

meta/documents/changelog_en.md

@@ -1,5 +1,19 @@
 # heidelpay Payment Gateway Changelog
 
+## [1.2.0][1.2.0]
+
+### Added
+- Added payment type ``secured Invoice B2C``.
+- Data-Container for additional payment information. [See User Guide for details.](user_guide_en.md)
+- Additional preview image.
+- Enabled basket transmission for secured payments.
+
+### Changed
+- Updated the User guides.
+
+### Removed
+- Removed obsolete code.
+
 ## [1.1.2][1.1.2]
 
 ### Fixed
@@ -39,4 +53,5 @@
 
 [1.1.0]: https://github.com/heidelpay/plentymarkets-gateway/tree/1.1.0
 [1.1.1]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.0..1.1.1
-[1.1.2]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.1..1.1.2
+[1.1.2]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.1..1.1.2
+[1.2.0]: https://github.com/heidelpay/plentymarkets-gateway/compare/1.1.2..1.2.0

meta/documents/user_guide_de.md

@@ -8,6 +8,7 @@ Aktuell werden folgende Zahlarten unterstützt:
 * Debitkarte
 * Lastschrift (ungesichert)
 * Sofort.
+* Gesicherter Rechnungskauf B2C
 
 ## Anforderungen
 * Dieses Plugin ist für Plentymarkets 7 entwickelt worden.
@@ -61,19 +62,19 @@ Diese Information erhalten Sie von ihrem heidelpay-Ansprechpartner.
 
 ###### Geheimer Schlüssel
 Der Schlüssel ist erforderlich, um einen Sicherheitshash zu generieren, der verwendet wird um zu verifizieren, dass alle Transaktionen tatsächlich vom heidelpay backend kommen.\
-Dieser Parameter ist erforderlich und darf nicht leer gelassen werden sein.
+Dieser Parameter ist erforderlich und darf nicht leer gelassen werden. Sie können hier eine beliebige Zeichenfolge eintragen.
 
 ##### Parameter für die Zahlarten
 ###### Aktiv
-Wenn diese Option angehakt ist, wird die entsprechende Zahlart auswählbar auf der Checkout-Seite.
+Wenn diese Option angehakt ist, wird die entsprechende Zahlart auf der Checkout-Seite auswählbar.
 
 ###### Anzeigename
 Der Name unter dem die Zahlart auf der Checkout-Seite angezeigt wird.\
 Wenn hier nichts eingetragen wird, wird der Standardname für die Zahlart angezeigt.
 
 ###### Channel-Id
 Die Id des Kanals auf dem für Sie die entsprechende Zahlart aufgeschaltet wurde.\
-Diese Information erhalten Sie von ihrem heidelpay-Ansprechpartner. 
+Diese Information erhalten Sie von ihrem heidelpay-Ansprechpartner.
 
 ###### Mindest-/Höchstbetrag
 Die Zahlart ist für Ihre Kunden nur auswählbar, wenn die Bestellsumme zwischen diesen beiden Werten liegt.\
@@ -103,12 +104,22 @@ Anforderungen an die URL:
 * sie muss mit 'http://' oder 'https://' beginnen
 * sie muss mit '.jpg', '.png' oder '.gif' enden
 
+### Daten Container
+#### Zusätzliche Zahlungsinformationen
+Dieses Modul stellt einen Container zur Verfügung, der Zahlungsinformationen (z.B. Überweisungsdaten für Rechnungskäufe) darstellt.\
+Um diese Informationen auf der Buchungsbestätigungs-Seite darzustellen folgen Sie bitte folgenden Schritten.
+1. wechseln Sie im Backend auf den Menüpunkt *CMS > Container-Verknüpfungen*
+2. wählen Sie im Drop-Down-Menü das Plug-in Set, für welches Sie die Änderung vornehmen möchten aus
+3. klappen Sie das Menü *Invoice Details (Heidelpay)* auf und aktivieren hier den Ceres-Container ``Order confirmation: Additional payment information``
+4. klicken Sie den speichern Button
+![Container-Verknüpfung](../images/preview_4.png)
+
 ## Beschreibung der Zahlungsabläufe 
 ### Kreditkarte und Debitkarte
 * Wenn für die Zahlart der **Buchungsmodus 'Direkte Buchung'** ausgewählt ist, wird die Zahlung sofort erzeugt und mit der Bestellung verknüpft.
 Es sind in diesem Fall keine weiteren Schritte notwendig um den Betrag zu buchen. Ist die Zahlung erfolgreich, wird die Bestellung sofort erzeugt und im Backend als bezahlt markiert.
 Schlägt die Zahlung fehl, wird die Bestellung nicht erzeugt und der Kunde wird zur Checkout-Seite umgeleitet.
-* Wenn für die Zahlart der **Buchungsmodus 'Reservierung mit Erfassung bei Rechnungserstellung'** ausgewählt ist, wird die Bestellung erzeugt aber die Buchung muss manuell im hip ausgelöst werden.
+* Wenn für die Zahlart der **Buchungsmodus 'Reservierung mit Erfassung bei Rechnungserstellung'** ausgewählt ist, wird die Bestellung erzeugt aber die Buchung muss manuell im hIP ausgelöst werden.
 Die Buchungstransaktion (Capture) wird dann in Ihren Plenty-Markets shop gepusht (hierfür die Push-URL im bei heidelpay eingetragen sein s. Anforderungen).
 Dies führt dazu, dass eine Zahlung im Plenty-Backend angelegt wird und mit der entsprechenden Buchung verknüpft wird.
 
@@ -121,6 +132,12 @@ Es sind keine weiteren Schritte notwendig, um den Betrag zu buchen.\
 Wenn die Zahlung erfolgreich ist, wird die Bestellung im Backend direkt als bezahlt markiert.\
 Wenn die Zahlung fehlschlägt, wird die Bestellung nicht erzeugt und der Kunde wird wieder auf die Checkout-Seite des Shops geleitet.
 
+### Gesicherter Rechnungskauf B2C
+Um die Sicherung zu aktivieren müssen Sie im hIP eine Finalisierung (FIN) ausführen.\
+Ab diesem Zeitpunkt startet der vertraglich festgelegte Versicherungzeitraum innerhalb dessen die Zahlung durch den Kunden erwartet wird.\
+Wenn der Kunde die Überweisung tätigt erscheint diese im hIP als Receipt (REC) und wird an die Push-URL ihres Shops gesendet.\
+Hier wird daraufhin eine Zahlung angelegt und mit der Buchung verknüpft.
+
 ### Alle Zahlarten
 * Zahlungen im Plenty-Backend enthalten die txnId (heidelpay Bestellnummer), die shortId (die eindeutige id der Transaktion d. h. Receipt, Debit oder Capture) und den Hinweis, dass es sich um eine durch heidelpay angelegte Zahlung handelt.
 * Im Falle eines Fehlers, der dazu führt, dass die Bestellung im Plenty-Backend nicht angelegt werden kann, während die Zahlung erfolgreich im heidelpay backend erzeugt wird, wird der Buchungstext der Zahlung um eine entsprechende Fehlermeldung erweitert.

meta/documents/user_guide_en.md

@@ -8,6 +8,7 @@ Currently supported payment methods are:
 * Debit Card
 * Direct Debit
 * Sofort.
+* Invoice secured B2C
 
 ## REQUIREMENTS
 * This plugin is designed fo Plentymarkets 7.
@@ -61,7 +62,7 @@ It should be given to you by your heidelpay contact person.
 
 ###### Secret key
 This is a security key required to create a hash value which is used to verify that the origin of any incoming transaction is the heidelpay payment backend.
-This parameter is required and can not be left empty.
+This parameter is required and can not be left empty. You can use any string for the secret key.
 
 ##### Payment Method Parameters
 ###### Active
@@ -103,6 +104,16 @@ Prerequisites for the url string:
 * it must start with 'http://' or 'https://'
 * it must end with '.jpg', '.png' or '.gif'
 
+### Data Container
+#### Additional payment data
+This modul provides for a data container to render additional payment information (e.g. bank data for invoice payments).\
+To show the information on your order confirmation page please follow these steps:
+1. switch to the menu item *CMS > Container Links*
+2. choose the corresponding plug-in set from the drop down
+3. open the menu *Invoice Details (Heidelpay)* and enable the ceres container ``Order confirmation: Additional payment information``
+4. click the save button
+![Container links](../images/preview_4.png)
+
 ## Workflow description
 ### Credit Card and Debit Card
 * If the payment method is configured to use *Transaction Mode* *'Direct debit'* the payment will be created immediately and referenced to the order.
@@ -123,6 +134,13 @@ There are no additional steps necessary to capture the amount.\
 If the payment is successful, the order is immediately marked paid in your backend.\
 If the payment fails, the order is not created and the customer will be redirected to the checkout page.
 
+### Invoice secured B2C
+In order to start the insurance of a Payment you need to trigger a finalize transaction (FIN) from the hIP.\
+This starts the insurance period in which the customer has to transfert the total amount of the order.\
+This period is determined within your contract with heidelpay.\
+As soon as the customer transferred the total amount a receipt transaction (REC) appears within the hIP and is sent to the pushUrl of your shop.\
+The shop module will then create a new payment and link it to the corresponding order.
+
 ### All payment methods
 * Payments contain the txnId (which is the heidelpay orderId), the shortId (the id of the transaction which lead to the payment i.e. Receipt, Debit or Capture) and the origin (i.e. heidelpay).
 * In case of an error resulting in the order not being created while the payment has been successful will lead to an unassigned plenty payment with the error message prepended to the booking text.

plugin.json

@@ -2,6 +2,14 @@
   "name": "Heidelpay",
   "namespace": "Heidelpay",
   "serviceProvider": "Heidelpay\\Providers\\HeidelpayServiceProvider",
+  "dataProviders":
+  [
+    {
+      "key"           :"Heidelpay\\Providers\\InvoiceDetailsProvider",
+      "name"          :"Invoice details",
+      "description"   :"Display invoice details to the customer."
+    }
+  ],
   "marketplaceName": {
     "de": "heidelpay Payment Gateway",
     "en": "heidelpay Payment Gateway"
@@ -13,7 +21,7 @@
   },
   "categories": ["3519"],
   "keywords": ["heidelpay", "plentymarkets", "plugin", "payment", "payment method", "credit card", "debit card", "sofort", "direct debit"],
-  "version": "1.1.2",
+  "version": "1.2.0",
   "license": "Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.",
   "price": 0.00,
   "author": "heidelpay GmbH",
@@ -23,10 +31,11 @@
   "type": "payment",
   "require": ["IO"],
   "dependencies": {
-    "heidelpay/php-basket-api": "^1.0.2",
-    "heidelpay/php-payment-api": "^1.6.0"
+    "heidelpay/php-basket-api": "^1.0.3",
+    "heidelpay/php-payment-api": "^1.7.1"
   },
   "runOnBuild": [
-    "Heidelpay\\Migrations\\CreateHeidelpayTables"
+    "Heidelpay\\Migrations\\CreateHeidelpayTables",
+    "Heidelpay\\Migrations\\AddInvoiceSecuredB2C"
   ]
 }

resources/lang/de/Config.properties

@@ -38,20 +38,6 @@ sofortChannelIdLabel=Channel-ID
 sofortMinAmountLabel=Mindestbetrag (in Euro)
 sofortMaxAmountLabel=Höchstbetrag (in Euro)
 sofortIconUrl=URL zum Icon der Zahlart
-paypalTab=PayPal
-paypalIsActiveLabel=Aktiv
-paypalDisplayNameLabel=Anzeigename
-paypalChannelIdLabel=Channel-ID
-paypalMinAmountLabel=Mindestbetrag (in Euro)
-paypalMaxAmountLabel=Höchstbetrag (in Euro)
-paypalIconUrl=URL zum Icon der Zahlart
-prepaymentTab=Vorkasse
-prepaymentIsActiveLabel=Aktiv
-prepaymentDisplayNameLabel=Anzeigename
-prepaymentChannelIdLabel=Channel-ID
-prepaymentMinAmountLabel=Mindestbetrag (in Euro)
-prepaymentMaxAmountLabel=Höchstbetrag (in Euro)
-prepaymentIconUrl=URL zum Icon der Zahlart
 directdebitTab=Lastschrift
 directdebitIsActiveLabel=Aktiv
 directdebitDisplayNameLabel=Anzeigename
@@ -61,4 +47,11 @@ directdebitTransactionTypePossibleValue0=Direkte Buchung
 directdebitTransactionTypePossibleValue1=Reservierung mit Erfassung bei Rechnungserstellung
 directdebitMinAmountLabel=Mindestbetrag (in Euro)
 directdebitMaxAmountLabel=Höchstbetrag (in Euro)
-directdebitIconUrl=URL zum Icon der Zahlart
+directdebitIconUrl=URL zum Icon der Zahlart
+invoicesecuredb2cTab=Gesicherter Rechnungskauf B2C
+invoicesecuredb2cIsActiveLabel=Aktiv
+invoicesecuredb2cDisplayNameLabel=Anzeigename
+invoicesecuredb2cChannelIdLabel=Channel-ID
+invoicesecuredb2cMinAmountLabel=Mindestbetrag (in Euro)
+invoicesecuredb2cMaxAmountLabel=Höchstbetrag (in Euro)
+invoicesecuredb2cIconUrl=URL zum Icon der Zahlart

resources/lang/de/template.properties

@@ -2,4 +2,15 @@ payNow = "Jetzt bezahlen"
 transactions = "Transaktionen"
 cancel = "Abbrechen"
 accountHolder = "Konto Inhaber"
-accountIban = "IBAN"
+accountIban = "IBAN"
+accountBic = "BIC"
+accountUsage = "Verwendungszweck"
+birthday = "Geburtsdatum"
+salutation = "Anrede"
+mr = "Herr"
+mrs = "Frau"
+day = "Tag"
+month = "Monat"
+year = "Jahr"
+choose = "wählen"
+pleaseTransferTheTotalTo = "Bitte überweisen Sie den vollen Betrag auf folgendes Konto"

resources/lang/en/Config.properties

@@ -38,20 +38,6 @@ sofortChannelIdLabel=Channel-ID
 sofortMinAmountLabel=min. Total (in Euro)
 sofortMaxAmountLabel=max. Total (in Euro)
 sofortIconUrl=URL to payment icon
-paypalTab=PayPal
-paypalIsActiveLabel=Active
-paypalDisplayNameLabel=Display name
-paypalChannelIdLabel=Channel-ID
-paypalMinAmountLabel=min. Total (in Euro)
-paypalMaxAmountLabel=max. Total (in Euro)
-paypalIconUrl=URL to payment icon
-prepaymentTab=Prepayment
-prepaymentIsActiveLabel=Active
-prepaymentDisplayNameLabel=Display name
-prepaymentChannelIdLabel=Channel-ID
-prepaymentMinAmountLabel=min. Total (in Euro)
-prepaymentMaxAmountLabel=max. Total (in Euro)
-prepaymentIconUrl=URL to payment icon
 directdebitTab=Direct Debit
 directdebitIsActiveLabel=Active
 directdebitDisplayNameLabel=Display name
@@ -61,4 +47,11 @@ directdebitMaxAmountLabel=max. Total (in Euro)
 directdebitTransactionTypeLabel=Transaction mode
 directdebitTransactionTypePossibleValue0=Direct debit
 directdebitTransactionTypePossibleValue1=Authorisation with capture
-directdebitIconUrl=URL to payment icon
+directdebitIconUrl=URL to payment icon
+invoicesecuredb2cTab=Invoice Secured B2C
+invoicesecuredb2cIsActiveLabel=Active
+invoicesecuredb2cDisplayNameLabel=Display name
+invoicesecuredb2cChannelIdLabel=Channel-ID
+invoicesecuredb2cMinAmountLabel=min. Total (in Euro)
+invoicesecuredb2cMaxAmountLabel=max. Total (in Euro)
+invoicesecuredb2cIconUrl=URL to payment icon

resources/lang/en/general.properties

@@ -3,5 +3,5 @@ errorMethodNotFound = "Payment method not found"
 errorUnknownPaymentCode = "Unknown payment code"
 debugSuccess = "Success!"
 errorSecurityHashInvalid = "Hashes do not match. This could be some kind of manipulation or misconfiguration!"
-errorSecretHashIsNotSet = "Hashe is missing. This could be some kind of manipulation or misconfiguration!"
+errorSecretHashIsNotSet = "Hash is missing. This could be some kind of manipulation or misconfiguration!"
 errorSecretKeyIsNotConfigured = "Please configure a secret key!"

resources/lang/en/template.properties

@@ -2,4 +2,15 @@ payNow = "Pay Now"
 transactions = "Transactions"
 cancel = "Cancel"
 accountHolder = "Account Owner"
-accountIban = "IBAN"
+accountIban = "IBAN"
+accountBic = "BIC"
+accountUsage = "Usage"
+birthday = "Birthday"
+salutation = "Salutation"
+mr = "Mr"
+mrs = "Mrs"
+day = "Day"
+month = "Month"
+year = "Year"
+choose = "choose"
+pleaseTransferTheTotalTo = "Please transfer the total amount using the following account data"