--- title: "Set up the plugin" description: "Learn how to set up, test, and go live with our Cegid Retail Y2 CPOS plugin." url: "https://docs.adyen.com/plugins/cegid-retail-y2/set-up-the-plugin" source_url: "https://docs.adyen.com/plugins/cegid-retail-y2/set-up-the-plugin.md" canonical: "https://docs.adyen.com/plugins/cegid-retail-y2/set-up-the-plugin" last_modified: "2024-12-19T14:37:00+01:00" language: "en" --- # Set up the plugin Learn how to set up, test, and go live with our Cegid Retail Y2 CPOS plugin. [View source](/plugins/cegid-retail-y2/set-up-the-plugin.md) 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](#test-integration) to make sure the plugin works correctly. After you are done testing, follow the [steps to go live with your integration](#go-live). ## Step 1: Download and install the plugin Download the plugin: 1. Contact our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) 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](/plugins/cegid-retail-y2/set-up-the-plugin/Cegid-Plugin-v2.1.26.zip) for [v2.1.26](/plugins/release-notes?title%5B0%5D=Cegid%20Retail%20Y2). 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](/account/user-roles): * Merchant POS Terminal Management Admin role ### Tab: Local communications 1. Log in to your [Customer Area](https://ca-test.adyen.com/) and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant account is shown). 2. Go to **In-person payments** > **Terminal settings** > **Integrations**. 3. Under **Terminal API** > **Enable terminal API**, select **Enabled**. 4. Under **Encryption key** select **Decrypted** and then complete the fields: * **Key identifier**: a description to recognize the key by. * **Key passphrase**: a string of random characters. * **Key version**: the version number of the key. For example, **1**. If this section is not visible or if you cannot edit the fields, ask our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) to set the required permission for your user. 5. Select **Save**. 6. Securely store the key identifier, passphrase, and version in your system. If you use local communications, you need these values when you are [setting up the plugin in Cegid Retail Y2](#configure-cegid). ### Tab: Cloud communications 1. Log in to your [Customer Area](https://ca-test.adyen.com/) and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant account is shown). 2. Create a new API credential: 1. Go to **Developers** > **API credentials**. 2. Select **Create new credential**. 3. Under **Credential type**, select **Web service**. You can add a description here. 4. Make a note of the API credential name. 5. Select **Create credential**. 6. Under **Server settings** > **Authentication**, elect the **API key** tab. 7. Select **Generate API key**. 8. Copy the API key using the copy icon **and store your API key securely in your system. 9. Select **Save changes.** 3. Go to **In-person payments** > **Terminal settings** > **Integrations** > **Terminal API**. 4. Under **Enable terminal API**, select **Enabled**. 5. Select **Save**. 6. Contact our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) to toggle the **Enable WebSockets** feature. ## 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](/point-of-sale/design-your-integration/determine-account-structure#create-stores) for the stores where you want the plugin to accept payments. 2. [Select the terminal models](/point-of-sale/what-we-support/select-your-terminals) that suit your business. 3. [Order test terminals](/point-of-sale/managing-terminals/order-terminals#sales-order-steps) and a test card from your test Customer Area. 4. [Board your terminals](/point-of-sale/managing-terminals/board-terminal) 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: ### Tab: Local communications | Field | Required | Description | | ----------------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Default Language** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The language you want to use for your terminals and plugin. | | **Logfile DCPP Layer** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | 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** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When enabled, this setting will allow accepting a payment with an unknown result after a failed transaction. | | **Payment configuration** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Default value: **D:CP,RR** If you want the default refund type to be [unreferenced](#refunds), set to **D:CP,NR**. For documentation on advanced use cases, refer to the documentation file in the installation folder. | | **URL** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Set to `https://YOUR_DEVICE_IP:8443/nexo`. | | **Connection Type** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Set to **Local**. | | **Sale ID** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID that will be used in your API requests for your POS, for example **Register1**. | | **POI ID** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID of your Adyen terminal that you can find in your [Customer Area](https://ca-test.adyen.com/). Go to **In-person payments** > **Terminals** and select your terminal. Your **POIID** in Cegid Retail Y2 is the **Permanent terminal ID**. | | **Key Identifier** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The key identifier value you set in your [Customer Area](https://ca-test.adyen.com/) in [Step 1](#configure-adyen). | | **Key Passphrase** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The key passphrase value you set in your [Customer Area](https://ca-test.adyen.com/) in [Step 1](#configure-adyen). | | **Key Version** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The key version value you set in your [Customer Area](https://ca-test.adyen.com/) in [Step 1](#configure-adyen). | | **Transaction TimeOut** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The transaction time-out in seconds. The default value for the transaction timeout is **120** seconds. | | **Request/Response TimeOut** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The internal timeout duration for the terminal. The default value for the request/response timeout is **3** seconds. | | **Nbr Customer Payment Receipts** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The number of merchant payment receipts printed by the printer. Use the default value **0** if the terminal prints the receipts. | | **Default Currency** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The default payment currency for your store. | | **Enable End Of Day** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When selected, the plugin will prompt the cashier to print an end of day total when closing a sales day. | | **Prompt For Signature** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When selected, the plugin will prompt the cashier to validate the signature of the shopper. | | **Legacy Mode** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | Deselected by default. Do not enable unless instructed by your Cegid contact. | | **Ignore Void** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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. | ### Tab: Cloud communications | Field | Required | Description | | ----------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Default Language** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The language you want to use for your terminals and plugin. | | **Logfile DCPP Layer** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | 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** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When enabled, this setting will allow accepting a payment with an unknown result after a failed transaction. | | **Payment configuration** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Default value: **D:CP,RR** If you want the default refund type to be [unreferenced](#refunds), set to **D:CP,NR**. For documentation on advanced use cases, refer to the documentation file in the installation folder. | | **URL** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | For your test integration, set to ****. For your live integration, set to the [endpoint that is geographically closest](/point-of-sale/design-your-integration/terminal-api#cloud) to your store location. | | **Connection Type** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | Set to **Cloud**. | | **Sale ID** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID that will be used in your API requests for your POS, for example **Register1**. | | **POI ID** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The unique ID of your Adyen terminal that you can find in your [Customer Area](https://ca-test.adyen.com/). Go to **In-person payments** > **Terminals** and select your terminal. | | **API Key** | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | The API key you generated in your [Customer Area](https://ca-test.adyen.com/) in [Step 1](#configure-adyen). | | **Transaction TimeOut** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The transaction timeout duration in seconds. The default value for the transaction timeout is **120** seconds. | | **Request/Response TimeOut** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The internal timeout duration for the terminal. The default value for the request/response timeout is **3** seconds. | | **Nbr Customer Payment Receipts** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | The default payment currency for your store. | | **Enable End Of Day** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When selected, the plugin will prompt the cashier to print an end of day total when closing a sales day. | | **Prompt For Signature** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | When selected, the plugin will prompt the cashier to validate the signature of the shopper. | | **Legacy Mode** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | Deselected by default, Do not enable unless instructed by your Cegid contact. | | **Ignore Void** | ![-x-](/user/data/smileys/emoji/x.png "-x-") | 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` ](/development-resources/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](/point-of-sale/what-we-support/payment-methods#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](#create-new-pm) for Adyen in Cegid Retail Y2 to trigger the plugin when doing a payment. 2. [Create a mapping table](#create-map) 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](/development-resources/paymentmethodvariant). 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](/point-of-sale/basic-tapi-integration/refund-payment/unreferenced). * **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](/point-of-sale/basic-tapi-integration/refund-payment/referenced). The **Payment configuration** you set when you [set up the plugin in Cegid Retail Y2](#configure-cegid) 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**. Keep in mind that in some cases, the amount will be refunded by unreferenced refund regardless of your **Payment configuration**. For example, partial refunds, and refunds for payments completed with multiple payment methods, the refund type will be unreferenced. 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](https://ca-test.adyen.com/) under **Transactions** > **Payments** > **Merchant Reference** and in [settlement details reports](/reporting/settlement-reconciliation/transaction-level/settlement-details-report). You need administrator rights to complete this configuration. 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](https://ca-live.adyen.com/). 2. Repeat [Step 1: Configure your Adyen account](#configure-adyen) in your live [Customer Area](https://ca-live.adyen.com/). 3. [Test your integration](#test-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](/plugins/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](#download-and-install-the-plugin). You do not need to follow the other steps on this page again. ## Next steps [Set up gift cards](/plugins/cegid-retail-y2/giftcards) [Set up gift card payments for your CPOS integration.](/plugins/cegid-retail-y2/giftcards) [Mobile POS and Live Store](/plugins/cegid-retail-y2/mobile-pos-and-live-store) [Learn more about using Tap to Pay on iPhone and Pay by Link using Cegid Retail Mobile POS and Live Store.](/plugins/cegid-retail-y2/mobile-pos-and-live-store)