Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Cegid Retail Y2

Use our Cegid Retail Y2 CPOS plugin to accept in-person payments.

  Read more
Learn more about Cegid in our Partner Directory.

Cegid Retail Y2 is a point-of-sale (POS) system. With our Cegid Retail Y2 CPOS plugin, you can process payments on the Adyen payments platform with Adyen payment terminals. The plugin and the terminals are integrated with our Terminal API. After you set up the CPOS plugin, you can also set up Cegid Retail Mobile POS and Cegid Retail Live Store integrations for iOS and Android devices.

Features

  • Gift card payments: allow shoppers to pay with gift cards.
  • Dynamic Currency Conversion: allow shoppers from abroad to pay in the local currency or their own currency.
  • QR code wallet payments: allow shoppers to pay with their QR code wallet app on their phone.
  • Partial payments: allow shoppers to pay the remainder with a different payment method.
  • Manual Key Entry: allow shopper to pay by manually entering their card details.
  • Tax-free shopping: allow shoppers from abroad to claim back taxes on their purchases with secure card sharing.
  • Delayed capture: set up a delay between the authorisation and capture of the payment.
  • Donations: allow shoppers to donate to a chosen charity at checkout. This feature is available for credit and debit card payments.
  • MOTO payments: allow shoppers to provide you with their order and payment details by regular mail (not email), fax, or telephone.

Supported versions

You can use our plugin to integrate with Cegid Retail Y2 versions 11.05 and later.

We recommend to use local communications, but it is also possible to use cloud communications:

  • Local communications: the POS system communicates directly with the payment terminal over your local network.
  • Cloud communications: the POS system communicates with the terminal over the internet. Contact our Support Team before you start building an integration using cloud communications.

You can use our decision tree to see which communication type is recommended for your situation.

How it works

Local Communications (recommended)

Cloud communications

Supported payment methods

You can use the plugin to accept payments with all payment methods supported by Adyen payment terminals.

Before you begin

Before you begin to integrate, make sure you have followed the Get started with Adyen guide to:

  • Get an overview of the steps needed to accept live payments.
  • Create your test account.

Step 1: Download and install the plugin

Download the plugin:

Install the plugin:

  1. Run the Setup_Retailstars.CAT.ADYEN.MULTI_2.0.**.exe file.
  2. When prompted to select a setup language, select English and then select OK.
  3. When prompted to select a destination location, enter the path to the Cegid Y2 CPOS_Pilotes folder on your computer. Make sure that the path includes the correct Cegid Retail Y2 version number for which you are installing the plugin. For example: C:\\Program Files (x86)\\Cegid\\Cegid Retail\\Cegid Retail Y2 17.0\\Front Office\CPOS_Pilotes
  4. In the Folder Exists pop-up window, select Yes.
  5. Verify that the Destination location is set correctly and select Install. You can only change the installation directory of CPOS by uninstalling and reinstalling after installation is complete.
  6. When the installation is complete, select Finish.
  7. Verify that the plugin is installed correctly:
    1. In your command line interface, run the following command with your CPOS installation path:
      C:\Program Files (x86)\Cegid\Cegid Retail\Cegid Retail Y2 17.0\Front Office>CPOS_DLLManager.exe -list
    2. In the response, check if you see Ok in the Sig field next to Retailstars.CAT.CPOS.ADYEN.MULTI.

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: Set up your Adyen account

  1. Log in to your Customer Area 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 Point of sale > Terminal settings > Integrations.
  3. Under Terminal API, select Enabled for Enable terminal API.

  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 can't edit the fields, ask our Support Team 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.

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:
Field Required Description
Default Language -white_check_mark- The language you want to use for your terminals and plugin.
Logfile DCPP Layer -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- 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- 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- 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- 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- 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- When enabled, this setting will allow accepting a payment with an unknown result after a failed transaction.
Payment configuration -white_check_mark- 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 -white_check_mark- Set to https://*/nexo.
Connection Type -white_check_mark- Set to Local.
Sale ID -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- The unique ID of your Adyen terminal that you can find in your Customer Area. Go to Point of sale > Terminals and select your terminal. Your POIID in Cegid Retail Y2 is the Permanent terminal ID.
Key Identifier -white_check_mark- The key identifier value you set in your Customer Area in Step 1.
Key Passphrase -white_check_mark- The key passphrase value you set in your Customer Area in Step 1.
Key Version -white_check_mark- The key version value you set in your Customer Area in Step 1.
Transaction TimeOut -x- The transaction timeout duration in seconds. The default value for the transaction timeout is 120 seconds.
Request/Response TimeOut -x- The internal timeout duration for the terminal. The default value for the request/response timeout is 3 seconds.
Nbr Customer Payment Receipts -x- The number of customer payment receipts printed by the printer. Use the default value 0 if the terminal prints the receipts.
Nbr Merchant Payment Receipts -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- The default payment currency for your store.
Enable End Of Day -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- When selected, the plugin will prompt the cashier to validate the signature of the shopper.
Legacy Mode -x- Deselected by default. Do not enable unless instructed by your Cegid point-of-contact.
Ignore Void -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.
  1. 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. Select Authorization request on entry if you want payment requests to be triggered automatically.
  4. Select Authorization while modifying payment.
  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

To set up payment methods, you have to:

  1. Create a new payment method 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. Select the Edit icon next to Mapping table.
  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 in Step 3 specifies the default type of refunds the configured payment method will execute.

Keep in mind that in some cases, the amount will be refunded by unreferenced refund regardless of your Payment configuration. For example if you are attempting a partial refund or if the payment was completed with multiple payment methods.

There are additional settings you have to configure to offer referenced refunds:

  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.

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 6 for the Number length, your first transaction will have [SALEID]1234000001** as merchant reference.

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 click 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.

Next steps

Mobile POS and Live Store

Learn more about the Mobile POS and Live Store solutions from Cegid Retail for iOS and Android devices.