Page tree
Skip to end of metadata
Go to start of metadata

How it works

The pixi* software is a software tool for smooth logistics and shipping processing with which shop operators can efficiently organize the shipping of ordered goods.

The aim of the app is to fully automatically display in the background for the merchant all standard business transactions that may occur in the mail order business in connection with shop orders paid for via PAYONE. The workflow of the merchant should not change at all in comparison to the handling of orders, which were made for example by cash on delivery or prepayment, and therefore no additional manual effort should arise.

This goal is achieved by the PAYONE pixi* App, which permanently monitors all orders placed in pixi* and registers any changes and reports them fully automatically to the PAYONE API gateway. For example, the subsequent addition or cancellation of an item, the dispatch or partial dispatch of the goods or even a return or partial return is reported directly to PAYONE so that the customer account can be adjusted accordingly.

Processes of the pixi* App in detail

Supported Payment Methods

VisaMastercardMaestroAmerican ExpressJCBDiners ClubDiscover

Information: Depending on the respective acceptance contract, other payment methods such as Visa Electron, Visa Debit and other cards can also be processed via the aforementioned payment methods. Please contact us if you need further information.
Verified by VisaMasterCard SecureCodeAmerican Express SafeKey

GiropaySofortEPSiDEALPostFinance

SEPAPrepaymentInvoice

PayPalPaydirekt

Import of orders from the webshop

Orders that were previously started in the shop via preauthorization or authorization are imported from the shop into pixi* using a modified pixi* shop connector.

Add / delete articles

In the case of later changes to the order, such as adding or deleting an article, the PAYONE pixi* App automatically notices this.

However, higher invoice amounts are only possible with direct debit. Here a higher invoice amount can be charged than originally reserved in the shop. The PAYONE pixi* App sends a debit call to PAYONE in case of an increase.

For the merchant there is no additional effort involved in these processes - the notification takes place automatically and fully automatically in the background. Should the PAYONE backend nevertheless report an error when changing the order, the shop operator will be informed by e-mail and the order will be blocked.

For the other payment methods, a subsequent increase in the invoice amount is not possible. The merchant must therefore ensure that his employees are informed that such orders may not be increased, e.g. in the case of subsequent telephone changes to the order!

If, on the other hand, the invoice amount is reduced, a return transfer of the difference is made immediately by the money collection (capture). With PayPal the rest of the reservation simply expires.
In case of an increase in a payment method that does not actually allow an increase (pixi* does not prevent the increase by itself), the app will send a warning email to the shop owner.

Dispatch of articles

For complete shipments from pixi*, the PAYONE pixi* App detects this automatically and sends the API command capture to PAYONE to debit the invoice amount.

Reversal

In the case of a full cancellation (customer calls the merchant after his order in the shop and says that he has changed his mind), the order is cancelled by the merchant in pixi*. PAYONE will not receive any further information; the pre-authorised invoice amount will automatically expire.
A partial cancellation only has the effect that the reduced amount is collected when the remaining articles are dispatched.

Returns

Of course, returns must also be processed by the app. The debit call is sent to PAYONE for this purpose.

Discounts and Vouchers

Subsequently no discounts may be entered in pixi* by the merchant for the order. Discounts are currently not supported by the PAYONE pixi* app.

The merchant may not use the coupon field in pixi*. Vouchers are currently not supported via the PAYONE pixi* App.

Exchange

The PAYONE pixi* App allows you to easily perform an exchange if the old item was more expensive or had exactly the same price as the new item. An exchange against a more expensive article goes however only with payment with direct debit.
For the other payment methods, an exchange for a more expensive item must always be processed as a return. The customer must order the desired exchange article then in the Shop again.
For Commerz Finanz transactions, an exchange cannot currently be processed with the PAYONE pixi* App.

Constraints

  • Currently, only payments in EUR are supported (restriction of pixi*).
  • Updates from pixi* can only be installed when PAYONE releases them. This means that the latest version of pixi* is not automatically supported.
  • In the current version of the app, a phone order can be placed in the Pixi client. A keyword must be stored in the app settings and this keyword must then be stored in the "Bank name" field of the order created in pixi.
  • A return with simultaneous depreciation may not be made in pixi*, as this is currently not correctly transmitted to PAYONE.
  • Several orders from the same customer may not be combined in pixi* as this is not compatible with PAYONE's pre-authorisations.

Installation

Overview

Please perform the installation step by step strictly according to this manual! As much as we have tried to create an intuitive installation routine, there are unfortunately many individual steps to consider that are not necessarily self-explanatory.
We therefore strongly recommend proceeding according to the instructions and, in particular, following our checklists (see below). This systematic procedure will make it much easier for you to commission the app.

The installation of the PAYONE pixi* App is divided into several steps:

Checking the installation prerequisites

  • You have a valid contract for PAYONE Processing
  • You have valid PAYONE access data (Merchant-ID, Sub-Account-ID, Portal-ID, security key).
  • You have booked the paid use of the pixi* API with pixi*.
  • You have already successfully completed the connection to PAYONE in your web shop or you are now doing so as part of the commissioning of the PAYONE pixi* App.

Booking the PAYONE pixi* App in the pixi* Apps Marketplace

The PAYONE pixi* App is available on the pixi* Apps Marketplace and can be booked with just a few clicks.
Please go to the pixi* Apps Marketplace at https://www.pixi.eu/apps-marketplace/. to perform the installation.
Use your pixi* database ID and the pixi* access data to log into the Marketplace.

If you are not working with the main user, please note that your user must be activated in the Marketplace to use the pixi* app.
In the Payment category you will find the PAYONE pixi* App. Select them and press the button:

Then read and agree to the Terms of Use. In the next step, allow the necessary data access by the PAYONE pixi* App. You can then log into your new app immediately.

Login

You can access the web interface of the PAYONE pixi* App at any time directly via the pixi* Apps Marketplace or by entering the following Internet address:

http://apps.pixi.eu/app/fc0988fe920100e24da0f04d893eb3b4/

The input mask for database identification, user name and password appears when you call it up:

As a rule, you can log in here with your normal access data, which you also use to start your pixi* program.
However, please note the stricter guidelines for user and password combinations in the pixi* Apps area:


  • Username and password must not be the same
  • User name and password must not match backwards.
  • The password must not be one of the following words: pixi, password, password, pass
  • The password must be at least 6 characters long.


I.e., although your password normally works in pixi* and also for the Marketplace or pixi*pedia, the app will only be accessible if the password meets the above criteria. After you have changed your password accordingly, you can log in.
If you are unable to log in despite observing these guidelines, please contact pixi* Support.

welcome screen

After the successful login, you will see the welcome screen of the web interface: In the list you will find all menu items that are also listed at the top of the screen, so you can switch between the various functions at any time.

Setup and configuration of the web interface

Settings

Please select the current shop or client from the select list whose settings you would like to edit.
After selecting the shop you will see the following view:

Move the mouse over the small question mark icons to read a help text.

Test mode

Here you can switch between productive and test mode. Depending on whether you have checked (= test mode on) or not (= productive mode on), communication with PAYONE takes place in test or productive mode. No payment transactions are made in test mode.

Deactivate Cronjobs

If this option is activated, no more data is automatically synchronized. It is recommended to leave this option disabled.

Last Synchronization

This timestamp indicates when the PAYONE pixi* app last synchronized with the pixi* database. The timestamp can be set manually to reprocess older operations. This should only be done by experts.

Process orders from this date with the PAYONE pixi* App

Enter the time stamp from which the PAYONE pixi* App pixi* is to process orders. Please make sure that you enter the date of installation and commissioning here, as otherwise large amounts of old data would be read in from pixi*, which would unnecessarily delay processing.

Last invoice synchronization

Shows when invoices were last exchanged between the PAYONE pixi* app and pixi*. The timestamp can be set manually to reprocess older operations. This should only be done by experts.

Process invoices from this date with the PAYONE pixi* App

Enter the timestamp from which the PAYONE pixi* App pixi* is to process invoices. Please make sure that you enter the date of installation and commissioning here, as otherwise large amounts of old data would be read in from pixi*, which would unnecessarily delay processing.

Sender email address for notifications from the PAYONE pixi* app

Enter a valid e-mail address for notifications and error messages. These e-mails should accumulate in your warehouse, so that a package can be stopped if necessary, it should come to a critical error message.

Payment Event ID

This value must be compared with the configuration settings of pixi*. By default, the correct value is: CRE - the pixi* support will tell you exactly which value is correct for your pixi* installation upon request.

Return value ID

This value must be compared with the configuration settings of pixi*. By default the correct value is: AND - which value is correct for your pixi* installation, the pixi* support will inform you on request.

Field for the article number

Please enter the field name which corresponds to the article number of pixi*. The default value is "ItemNrSuppl".
The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.

Retention time of API logs

Select a period of 1-12 weeks to specify how long logs should be kept. We recommend a duration of 4 weeks. Older logs are deleted once per night to save storage space.

Forward unsigned refund amounts to Pixi

Specify the sign to be passed here.

  • Activated > A positive amount is transferred (unsigned)
  • Deactivated (preselected) > A negative amount is transferred ( sign = "-" )

PAYONE Merchant ID

Please enter your PAYONE Merchant ID here.

PAYONE Sub-Account ID

The sub-account you have defined under which payments are to be processed with the PAYONE pixi* App.

PAYONE Portal ID

The identification number of the payment portal you have configured that is to be used for processing payments.

Key (security key)

The value you define in the payment portal for encrypting communication.

Abbreviation for the payment method Credit Card (credit card)

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for Direct Debit payment method (SEPA Direct Debit)

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for the payment method online bank transfer

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for the payment method E-Wallet

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for the payment type prepayment

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for the payment type invoice

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Abbreviation for the payment type debit memo

This value must be compared with the configuration settings of pixi*. The pixi* support will tell you exactly which value is correct for your pixi* installation upon request.
Please only enter a value if the payment method is also handled via PAYONE. Otherwise please enter "not used".
You can find further information under Supplement payment types.

Adaptation of the pixi* shop connector

You have to make the following adjustments in your shop in order to transfer the required data from the shop to pixi*:
PAYONE txid (transaction-id) → pixi* Bank name / Bank_Name
PAYONE credit card pan → pixi* Account holder / Holder
An example record looks like this:
<HOLDER>70054229</HOLDER>
<BANK_NAME>1234567890</BANK_NAME>
The so-called pixi* shop connector is usually adapted for this data transfer. For shop systems such as OXID, Magento, xt:Commerce, pixi* provides standard connectors that are installed in the shop by pixi*.
Please contact the pixi* support. As a rule, pixi* advises against processing the shop connector independently, unless you have developed your own shop.

Adaptation of the pixi* configuration settings

Some settings must also be made in pixi* itself. The following adjustments are best ordered directly from pixi* Support:

Add payment types

In pixi* nine additional payment methods "PAYONE Credit Card", "PAYONE Direct Debit", "PAYONE Online Bank Transfer", "PAYONE E-Wallet", "PAYONE BillSAFE", "PAYONE Commerz Finanz", "PAYONE Prepayment", "PAYONE Invoice" and "PAYONE Direct Debit" must be added. The pixi* support will be happy to provide you with the internal letter abbreviations for these payment methods in your pixi* installation upon request.

Adjust job import status

Purchases processed with the PAYONE platform are initially imported at HAL (Hold) status so that the Cronjob app has the opportunity to recognize new orders. The cronjob immediately switches new orders (orders) to status ANG (accepted) when they are recognized, since the payments have already been successfully pre-authorized in the webshop.

Setting up event IDs in pixi*

So that the customer account can be cleared automatically by the app, you must create corresponding event IDs in the app. To do this, go to the pixi* customer service under Tools → Settings → Customer account and click on New.
You can enter any account number and account description, only the amount must be positive for both accounts. You should set the account ID for paid invoices to CRE and the account ID for returns to AND.
You can also use any other account ID. All you have to do is make sure that the same IDs are set in pixi* and in the settings you make in the web interface of the app.

Transmission of the TransactionStatus

PAYONE confirms most transactions with an asynchronous TransactionStatus call. Here, for example, the success of transactions such as capture or payment is subsequently confirmed.
In the PAYONE Merchant Interface (PMI), you define a URL to which this TransactionStatus is to be transferred. The URL of your online shop is usually already stored here, so that the web shop is informed about the status of transactions.
When using the PAYONE pixi* app, this TransactionStatus information is also required in the pixi* app. Since you can only store one target URL in the PMI, you must forward the status from the shop to the pixi* app.

The PAYONE integrations for Magento, Shopware and Oxid offer a configuration option so that you can directly forward the TransactionStatus to pixi*. Please enter the following target URL:
https://apps.pixi.eu/app/fc0988fe920100e24da0f04d893eb3b4/db.<pixi customer abbreviation>/index.php/tcpa/status?appaccess=<Key>
<pixi customer abbreviation> = your abbreviation for your customer identification at pixi*.
<key> = the "password for unprotected access" you specified in the pixi* Apps Marketplace for the PAYONE pixi* App.
Example:
https://apps.pixi.eu/app/fc0988fe920100e24da0f04d893eb3b4/db.ABC/index.php/tcpa/status?appaccess=568u654g65456s5e54k546j546t45fb4
For all other integrations / shop systems, please contact PAYONE Support.

Logs

In addition to the settings already presented, searchable log files are provided via the web interface, which can be used to track every order and every invoice. All API calls sent by the app in this context to the pixi* API or to the PAYONE platform are also logged.

Order overview

By entering corresponding search values in the fields above, the database can be conveniently searched. By clicking on an order you get the following detailed view:

Here you can see the status and various background information on the selected order, as well as the status of each individual item in the order.

Overview invoices

By entering corresponding search values in the fields above, the database can be conveniently searched. By clicking on an invoice you get the following detailed view:


Here you can see the status and various background information about the selected invoice, as well as the status of each individual item on this invoice. From here you can also use the link to the detailed view of the order on which this invoice is based.

Cron jobs

The PAYONE pixi* App is called via time-controlled processes, so-called cronjobs.
There are several such time-controlled processes whose last execution date is displayed on the Cronjobs log overview.
CHANGED_INVOICES:
Runs every 5 minutes and checks if there are modified invoices in pixi* that should trigger an action in the pixi* app.
CHANGED_ORDERS:
Runs every 5 minutes and checks if there are any changed orders in pixi* that should result in an action in the pixi* app.
CLEAR_LOG:
This cronjob cleans up the log files once a day to save disk space. The duration of the storage of logfiles can be configured in the settings.
PENDINGAPPROVE:
This cronjob checks once a day whether Commerz Finanz transactions have been confirmed, which are then released for dispatch in pixi* if processed positively.
REQUEST_QUEUE:
This cronjob processes the commands in the process queue every 5 minutes.

Open Calls

If commands from the process queue have not been processed successfully, they remain in the Open Calls overview so that you can subsequently determine why the processing of an order or invoice may have failed or where further processing may have failed.

In general, an unsuccessfully executed call blocks all further processing of an order so as not to completely disrupt the workflow.

If, for example, the dispatch message has not been successfully transmitted to PAYONE, no returns can be recorded for this order, as the dispatch has not even been transmitted correctly. It is possible to re-execute a previously failed call with a mouse click if, for example, the circumstances that caused the interruption have been eliminated in the meantime. Alternatively there is also the possibility to delete or skip a call. This should only be done by experts.

API log

The API Log logs all commands sent to the pixi* API as well as to the PAYONE Server API. API, function, time stamp and various related data such as order number and invoice number are also listed.

The fields above the table allow you to search the API log for orders, invoices or API calls.

By clicking on an API log entry you get a detailed view including the sent and received parameters, so that a deeper debugging is possible.

Update the app

A possibly available update of the PAYONE pixi* app is automatically activated for you whenever you log on to the web interface of your app. You can see the current version in the lower right corner of the web interface. In the pixi* Apps Marketplace you can always keep up to date with new updates and their content.

Checklist for pixi* Support

The pixi* API must be set up and the following API calls must be available:

  • pixiGetAddress
  • pixiGetInvoice
  • pixiGetInvoiceLines
  • pixiGetItemInfo
  • pixiGetOrderHeader
  • pixiGetOrderline
  • pixiGetOrderLinesForOrder
  • pixiGetUpdatedInvoices
  • pixiInvoiceSetInfo
  • pixiOrderSetInfo
  • pixiReleaseOrder

The pixi* shop connector, which connects the merchant's shop with the pixi* mail order software, has to be adapted. Details can be found above in this document in the section Adaptation of the pixi* Shop Connector.

The used pixi* version works with PAYONE and is released.

PAYONE orders arriving in pixi* must be set to status HOLD.

The six PAYONE payment methods must be created in pixi*. The payment type abbreviations must match the entries stored in the Web interface of the app for abbreviations for the payment type ... correspond.

In the case of returns with a PAYONE payment type, no automatic account transfers may be carried out.

Checklist for the Merchant

You have signed a contract for PAYONE Processing and received valid access data (Merchant-ID, Sub-Account-ID, Portal-ID and security key) from PAYONE.

In your shop you have installed PAYONE according to the PAYONE specifications.

You have activated the PAYONE pixi* App in the pixi* Apps Marketplace.

You have adapted the pixi* shop connector (for standard shops such as OXID, please order this directly from pixi*); you must integrate your own shop solutions independently in accordance with the section Adaptation of the pixi* shop connector above in this document.

The payment event ID must be compared with the configuration settings of pixi*. By default, the correct value is: CRE - match this value with the setting in the web interface of the PAYONE pixi* app.

The return value ID must be compared with the configuration settings of pixi*. By default, the correct value is: AND - match this value with the setting in the Web interface of the PAYONE pixi* app.

You have logged into the Web interface of the app and made all settings there, in particular:

  • The test mode is switched off.
  • In the six fields Abbreviations for the payment method ... is the letter for the corresponding PAYONE payment type as defined in pixi*.
  • Your valid PAYONE access data are stored in the settings of the web interface.


When all points of your checklist have been completed and pixi* confirms that the pixi* Support Checklist has been completed, you should start by placing several test orders to familiarize yourself with the way the app works before going live with the application for real customers in your shop.

Troubleshooting and Support

When troubleshooting, we recommend that you first check the two checklists in this document again and read through this manual again from A-Z. Most questions can already be answered in full by reading the manual.

Support

Do you need further support? Please use the support form for the PAYONE pixi* App in the Fatchip Form Center: https://www.fatchip.de/Plugins/Support/Formularcenter/

  • No labels