...
Introduction
This plugin integrates VAI Pay as a payment method in your JTL store.
...
System requirements
JTL-Shop 5.00+ and its requrementsrequirements
Other requirements
You need a customer account, register at: https://vaitrade.de/de/b2b.
...
The plugin will help you to set up the payment method, for this select the "Help" tab in the plugin. There you will get an overview of the configuration. At the point, check the settings you have stored for the payment and shipping methods.
...
Payment methods
The configuration of the payment type is done via the standard administration in the JTL store. You can find the payment types under Administration → Payment methods. You can also find a direct link on the help page of the plugin. Select VAI Pay via the pencil icon and configure the payment method as needed.
...
You specify where and with which method the button is embedded via the selector and selector method.
Option | WerteValues | BeschreibungDescription |
|---|---|---|
Active: | Yes / No | Here you can globally enable or disable the plugin. |
API-Key: | Enter the API key here that you received from VAI Pay after your registration. This serves as the access key for communication with VAI Pay. | |
Secret-Key: | Enter the secret key for communication with VAI Pay here. You have also received this after your registration with VAI Pay. This is used to secure the communication with VAI Pay. | |
Mode: | Sandbox / Live | Select the operating mode here Sandbox - the plugin communicates with the test environmentLive environment |
Button colorshemecolor sheme: | Light / Dark | Select the color scheme for the pay button here. |
Button text: | “Bezahlen mit VAI” | Choose your favorite button text. The text will be displayed in the VAI Pay button. |
Button selector (bind): | CSS - Selektor Standard: #complete-order-button | pecify Specify the CSS selectors (comma-separated) to which the button should be bound. If nothing is specified, then the default selector is used. |
Button selector method: | after - nach before - davor append - anhängen prepend - voranstellen replaceWith - ersetzen | after - the button will be added after the specified element before - the button will be added before the specifying element append - the button will be appended to the specifying element prepend - the button will be prepended to the specified element replaceWith - the specified element will be replaced with the button |
Element selector (remove): | Specify here the CSS selectors of the elements that should be hidden. By default, the element "#complete-order-button" is always hidden. If your button ID is named differently, you can specify your own selector here. |
...
Create "Vai Pay" as the payment method. Note that the payment methods must correspond to the "Displayed name" in the JTL store.
...
...
Set up the order attribute
Change to Verkauf (F6) und open an order. You can edit the order attributes with
...
Create the Attribute “VaiDealNumber“. Now the transitted transmitted dealNumber is displayed:
...
Set up JTL-Workflow
...
Set up "Vai Pay" as a payment method.
Open Admin >JTL-Workflows:
Choose Aufträge:
and mark up “Komplett bezahlt”
Create a new Workflow:
Define conditions:
Define for the previously created payment type "Vai Pay" that payments should be processed.
Set up actions:
In Table Adressdata Address data all variables are listed which have to be changed.
Choose action “Werte setzen“
Specify with "Variable" which value should be changed for
Auftrag > Zahlungen > Rechnungsadresse > VariableSpecify the new value for Wert.
Option “Feld leeren” is not available, to empty a variable please insert a "-" (minus) as a workaround.
Test Workflow
Save the Workflow
...
Address data
The setup help is intended to assist you in entering all the required variables.
...
Column | Description |
|---|---|
Order ID | JTL-Shop order Id |
Customer | Name of the customer |
Invoice ID | Internal invoice number (UUID generated by the plugin) |
Deal-Number | VAI Pay deal number (internal ID generated by VAI Pay) |
Status | Status of the payment (confirmed/unconfirmed). The status is confirmed when the order has been created in the JTL store and VAI Pay has confirmed the transferred amounts. |
Total Sum | Total gross amount in the JTL store (due to any fees, the amounts in the VAI customer account may differ). |
Order date | Timestamp of the order or payment |
IP-Address | IP of the buyer/customer |
...
You can find the shop log in the JTL admin area under Administartion Administration → Troubleshooting → Log.
The JTL log works with log levels in order not to fill the database with log data indefinitely. Conversely, this means that you will only see log messages if they have been generated after the log level has been changed. The plug-in logs almost exclusively in the debug log level, except for critical errors. So if something does not work, you should first activate the debug log level, then perform a test order, then deactivate the debug log level again and consult the messages logged in the meantime.
...
Changelog
v1.0.0 (August 2022)
Initiales Initial Release
Support und Contact
siehe goto Support und KontaktContact