Set up the plugin

Follow the steps below to set up the CPOS plugin in your Adyen Customer Area and the Cegid Retail Y2 back office. After you have completed the setup steps, test your integration to make sure the plugin works correctly.

After you are done testing, follow the steps to go live with your integration.

Step 1: Download and install the plugin

Download the plugin:

1. Contact our Support Team to receive the password for the plugin installation file.
2. Only if you have already integrated with the plugin and are downloading to upgrade to a later version:
   a. Uninstall older versions of the plugin.
   b. Reboot the device that Cegid Retail Y2 is installed on.
3. Download and unzip the password protected Cegid Retail Y2 CPOS plugin installation file.

Install the plugin:

1. Run the Setup_Retailstars.CAT.ADYEN.MULTI_2.1.*.exe file.
2. When prompted to select a setup language, select English and then select OK.
3. The installation path defaults to C:\Program Files (x86)\Retailstars\CPOS, in the Folder Exists pop-up window, select Yes.
4. Double-check that the Destination location is set to the correct installation path. You can only change the installation directory of CPOS by uninstalling and reinstalling after installation is complete.
5. Select Install.
6. When the installation is complete, select Finish.

Check if the plugin is connected to Cegid Retail Y2 correctly:

1. In the Cegid Retail Y2 back office, go to Settings > Registers and select your register.
2. Select Settings for Peripheral and then select EPT.

3. Check if the following values are set correctly:

   • DLL name: Retailstars.CAT.CPOS.ADYEN.MULTI
   • Driver name: ADYEN.MULTI

   If required, manually set the correct values.

4. If you want to process payments with gift cards, set the Identifier to 1.

Step 2: Configure your Adyen account

For this task, you must have the following user role:

• Merchant POS Terminal Management Admin role

Step 3: Get your Adyen payment terminals

The plugin can only communicate with terminals that are injected with Adyen software. To obtain these terminals:

1. Create store IDs for the stores where you want to the plugin to accept payments.
2. Select the terminal models that suit your business.
3. Order test terminals and a test card from your test Customer Area.
4. Board your terminals to associate them with a store and make them ready to accept test payments.

Step 4: Set up the plugin in Cegid Retail Y2

To configure the CPOS plugin in the Cegid Retail Y2 back office:

1. In the Cegid Retail Y2 back office, go to Settings > Registers and select your register.

2. Select Settings for Peripheral and select EPT.

3. Select Settings for Peripheral and fill these properties:

   Local communications Cloud communications

   Local communications Cloud communications

   Field	Required	Description
   Default Language		The language you want to use for your terminals and plugin.
   Logfile DCPP Layer		The path to the logging file for communication between Cegid Retail Y2 and the plugin. For example: YOUR_CEGID_INSTALL_DIRECTORY\CPOS\Retailstars.CAT.ADYEN.MULTI\Log\DCPP.
   Logfile DRV Layer		The path to the logging file for communication between the plugin and Adyen. For example: YOUR_CEGID_INSTALL_DIRECTORY\CPOS\Retailstars.CAT.ADYEN.MULTI\Log\DRV.
   Directory Licence + Config		The directory where the configuration can be read or files can be stored temporarily, for example the custom translation file. For example: YOUR_CEGID_INSTALLATION_PATH\Front Office\CPOS_Pilotes\Retailstars.CAT.ADYEN.MULTI\Config.
   Wait After Transaction Success		The waiting time of your terminals after each payment before the next payment can be accepted. Set to 0 if no waiting time is required, -1 to wait until cashier confirmation, or set to a positive number to specify a waiting time in seconds.
   Printer ID for Payment Receipt		The ID of the printer where the payment receipts should be printed to. When set to 0, the receipt is printed to the screen.
   Payment Receipt Model		The model of the payment receipt that will be printed. You can leave the default setting or set it to ON1, Z01, or Z09.
   Allow Booking of Undetermined Payment		When enabled, this setting will allow accepting a payment with an unknown result after a failed transaction.
   Payment configuration		Default value: D:CP,RR If you want the default refund type to be unreferenced, set to D:CP,NR. For documentation on advanced use cases, refer to the documentation file in the installation folder.
   URL		Set to https://YOUR_DEVICE_IP:8443/nexo.
   Connection Type		Set to Local.
   Sale ID		The unique ID that will be used in your API requests for your POS, for example Register1.
   POI ID		The unique ID of your Adyen terminal that you can find in your Customer Area. Go to In-person payments > Terminals and select your terminal. Your POIID in Cegid Retail Y2 is the Permanent terminal ID.
   Key Identifier		The key identifier value you set in your Customer Area in Step 1.
   Key Passphrase		The key passphrase value you set in your Customer Area in Step 1.
   Key Version		The key version value you set in your Customer Area in Step 1.
   Transaction TimeOut		The transaction time-out in seconds. The default value for the transaction timeout is 120 seconds.
   Request/Response TimeOut		The internal timeout duration for the terminal. The default value for the request/response timeout is 3 seconds.
   Nbr Customer Payment Receipts		The number of customer payment receipts printed by the printer. Use the default value 0 if the terminal prints the receipts. If you want to enable the optional printing prompt for approved transactions, set to -1.
   Nbr Merchant Payment Receipts		The number of merchant payment receipts printed by the printer. Use the default value 0 if the terminal prints the receipts.
   Default Currency		The default payment currency for your store.
   Enable End Of Day		When selected, the plugin will prompt the cashier to print an end of day total when closing a sales day.
   Prompt For Signature		When selected, the plugin will prompt the cashier to validate the signature of the shopper.
   Legacy Mode		Deselected by default. Do not enable unless instructed by your Cegid contact.
   Ignore Void		The default behavior of the plugin for Void requests. It is recommended to set this value to Confirm Void. This will prompt the cashier to explicitly confirm or reject void by typing Yes or No in a text field.

   Field	Required	Description
   Default Language		The language you want to use for your terminals and plugin.
   Logfile DCPP Layer		The path to the logging file for communication between Cegid Retail Y2 and the plugin. For example: YOUR_CEGID_INSTALLATION_PATH\FrontOffice\CPOS_Pilotes\Retailstars.CAT.ADYEN.MULTI\Log\DCPP.
   Logfile DRV Layer		The path to the logging file for communication between the plugin and Adyen. For example: YOUR_CEGID_INSTALLATION_PATH\FrontOffice\CPOS_Pilotes\Retailstars.CAT.ADYEN.MULTI\Log\DRV.
   Directory Licence + Config		The directory where the configuration can be read or files can be stored temporarily, for example the custom translation file. For example: YOUR_CEGID_INSTALLATION_PATH\Front Office\CPOS_Pilotes\Retailstars.CAT.ADYEN.MULTI\Config.
   Wait After Transaction Success		The waiting time of your terminals after each payment before the next payment can be accepted. Set to 0 if no waiting time is required, -1 to wait until cashier confirmation and a positive number to specify a waiting time in seconds.
   Printer ID for Payment Receipt		The ID of the printer where the payment receipts should be printed to. When set to 0, the receipt is printed to the screen.
   Payment Receipt Model		The model of the payment receipt that will be printed. You can leave the default setting or set it to ON1, Z01, or Z09.
   Allow Booking of Undetermined Payment		When enabled, this setting will allow accepting a payment with an unknown result after a failed transaction.
   Payment configuration		Default value: D:CP,RR If you want the default refund type to be unreferenced, set to D:CP,NR. For documentation on advanced use cases, refer to the documentation file in the installation folder.
   URL		For your test integration, set to https://terminal-api-test.adyen.com/sync. For your live integration, set to the endpoint that is geographically closest to your store location.
   Connection Type		Set to Cloud.
   Sale ID		The unique ID that will be used in your API requests for your POS, for example Register1.
   POI ID		The unique ID of your Adyen terminal that you can find in your Customer Area. Go to In-person payments > Terminals and select your terminal.
   API Key		The API key you generated in your Customer Area in Step 1.
   Transaction TimeOut		The transaction timeout duration in seconds. The default value for the transaction timeout is 120 seconds.
   Request/Response TimeOut		The internal timeout duration for the terminal. The default value for the request/response timeout is 3 seconds.
   Nbr Customer Payment Receipts		The number of customer payment receipts printed by the printer. This value should be left as default (0) if the terminal prints the receipts.
   Nbr Merchant Payment Receipts		The number of merchant payment receipts printed by the printer. This value should be left as default (0) if the terminal prints the receipts.
   Default Currency		The default payment currency for your store.
   Enable End Of Day		When selected, the plugin will prompt the cashier to print an end of day total when closing a sales day.
   Prompt For Signature		When selected, the plugin will prompt the cashier to validate the signature of the shopper.
   Legacy Mode		Deselected by default, Do not enable unless instructed by your Cegid contact.
   Ignore Void		The default behavior of the plugin for Void requests. It is recommended to set this value to Confirm Void. This will prompt the cashier to explicitly confirm or reject void by typing Yes or No in a text field.

4. Save your changes.

Step 5: Configure cash register settings

To configure the settings for your cash register:

1. Log in to your Cegid Retail Y2 back office.
2. Go to Register settings > Peripherals.
3. Under Electronic Payment Terminal, select Authorization request on entry to automatically trigger payment requests for cash register entries. If you want to manually make payment requests, leave this box unchecked.
4. Select Authorization while modifying payment, and Allocation of transaction number.
5. Save your changes.
6. Go to Register settings > Preferences.
7. In the list of Authorized methods of payment, select all payment methods you want to use.

Step 6: Set up payment methods

Adyen payment terminals return paymentMethodVariant values that need to be translated into values that Cegid Retail Y2 can use. There are two ways to set up payment methods:

• Create a default payment method for Adyen and use a mapping table to map the values to different payment methods.
• Create multiple payment methods for different types of payment methods, or currencies. For example:
  • Create a payment method for QR code wallets, and use the mapping table to specify the values for each QR code wallet payment method.
  • Create a payment method for the US Dollar currency, and use the mapping table to specify what type of cards can be used to pay with this currency.

To set up payment methods, you have to:

1. Create a new payment method, or multiple payment methods for Adyen in Cegid Retail Y2 to trigger the plugin when doing a payment.
2. Create a mapping table to link the payment method codes used by the Adyen terminal and the plugin.

Create a new payment method

1. Log in to your Cegid Retail Y2 back office.
2. Go to Management > Payment methods. This shows the payment methods available for your store.
3. Create a new payment method. A pop-up window will appear.
4. On the Characteristics tab:
   1. Choose a Code, for example ADY.
   2. Choose a Short name, for example Adyen.
   3. For Category select Bank cards.
   4. For Direction select Mixed. This allows to offer refunds to your shoppers.
5. On the Additions tab:
   1. Select Card no, Expiry date, Type of card, Control number, Cardholder name, CVV / CV2/ CID, and Transaction no.
   2. Select Authorisation number.
   3. Select Send amount to EPT.
6. On the Front-Office tab, select the Usable in register checkbox and set Type to Bank card.
7. Save your changes.

Create a mapping table

1. Go to Register settings > Peripheral settings > EPT.
2. Find the Mapping table and select the Edit icon next to it.
3. Create a mapping table and name it, for example Adyen.
4. On your mapping table, create entries to link the payment methods with the paymentMethodVariant values sent by Adyen terminals.
5. Save your mapping table.
6. Activate your mapping by selecting the table you created next to Mapping table.

Step 7: Configure refund settings

You can offer two types of refunds to your shoppers:

• Refund without control: refund any amount to any card presented to the payment terminal. Adyen refers to this kind of refunds as unreferenced refunds.
• Refund with control: refund the partial or full amount connected to an original payment, using the unique identifier of that payment. Adyen refers to this kind of refunds as referenced refunds.

The Payment configuration you set when you set up the plugin in Cegid Retail Y2 specifies the default type of refunds the configured payment method will execute.

To offer referenced refunds, there are additional settings to configure:

1. Log in to your Cegid Retail Y2 back office.
2. Go to Register settings > Management.
3. Select Check returns of merchandises and Checking reimbursement card.

For documentation on advanced use cases, refer to the documentation file in the installation folder.

Step 8 (Optional): Configure merchant reference

You can configure a merchant reference to customize the value that shows up in the Adyen Customer Area under Transactions > Payments > Merchant Reference and in settlement details reports.

To configure a merchant reference:

1. Log in to your Cegid Retail Y2 back office.
2. Go to Register settings > Peripherals.
3. Under Electronic Payment Terminal, set a Transaction number prefix and a Number length.
4. Save your changes.

After you configured a merchant reference, your transactions are registered to Cegid Retail Y2 and Adyen according to the values you set. For example, if you set 1234 for the Transaction number prefix and 10 for the Number length, your first transaction will have [SALEID]1234000001 as merchant reference.

Make sure that the Number length you set is higher than the amount of characters you have in the Transaction number prefix. If your prefix is longer than the length, for example, if you set 12345 for the Transaction number prefix, and 4 for the Number length, CPOS uses the date and time instead.

Test and go live

Test your integration

Check if the plugin is communicating correctly with the terminal:

1. In the Cegid Retail Y2 back office, go to Settings > Registers and select your register.
2. Select Settings for Peripheral and then select EPT.
3. On the Management Tab select Device test.
4. Verify that the pop-up window shows Test successful. This means that your plugin has been configured correctly.

After you have verified your plugin is configured correctly, perform a test transaction:

1. Log in to your Cegid Retail Y2 back office.
2. Go to Sales receipts > Enter transaction.
3. Choose an item and give it a price.
4. Select ADYEN CREDIT CARDS and then select the icon.
5. Pay with your Adyen terminal using your Adyen test card.
6. In Cegid Retail Y2, check if there is a receipt for the test transaction.

Go live

There are steps you have to complete after testing your integration before you can start accepting real payments:

1. Order new payment terminals from the live Customer Area.
2. Repeat Step 1: Configure your Adyen account in your live Customer Area.
3. Test your integration to make sure the plugin has been configured correctly.

Upgrade the plugin

When a new version of the plugin is released, you can find it in our release notes. When there is a new version, we update our documentation with the new installation file.

To upgrade your plugin, follow the steps the download and install the plugin. You do not need to follow the other steps on this page again.

If you are upgrading to a later version from a version earlier than v2.1.0, you need to uninstall any older versions you have installed and reboot before you download the new version.