Protect with a library

Before you begin

• Make sure you have:
  • Installed our .NET library in your project.
  • Installed Adyen's root certificate.
  • Set up a shared key.

Use the .NET library

1. In your C# project, create a Config object specifying:

   • The URL of the terminal.
   • The environment: Test or Live.
   • Your merchant account.

   Config config = new Config
       {
           Endpoint = "https://TerminalApiEndpoint:8443/nexo/",
           Environment = Model.Enum.Environment.Test,
           MerchantAccount = "YOUR_MERCHANT_ACCOUNT"
       };

2. Create a Client object using the Config object created in the previous step.

   Client client = new Client(config);

3. Create the PosPaymentLocalApi service using the client created in the previous step.

   Service.PosPaymentLocalApi posPaymentLocalApi = new Service.PosPaymentLocalApi(client);

4. Create an EncryptionCredentialDetails object specifying the identifier, passphrase, and version of your shared key.

   EncryptionCredentialDetails encryptionCredentialDetails = new EncryptionCredentialDetails
       {
           AdyenCryptoVersion = 1,
           KeyIdentifier = "KEY_IDENTIFIER",
           Password = "KEY_PASSPHRASE",
           KeyVersion = 1
       };

5. When you send a Terminal API request to the payment terminal, use the PosPaymentLocalApi service specifying a SaleToPOIRequest object and the EncryptionCredentialDetails object.

   SaleToPOIResponse response = posPaymentLocalApi.TerminalApiLocal(saleToPOIRequest, encryptionCredentialDetails);

The iOS library supports deriving the encryption key and encrypting and decrypting communications.

Before you begin

• Make sure you have:
  • Installed our iOS library (TerminalAPIKit) in your project.
  • Installed Adyen's root certificate.
  • Set up a shared key.

Derive the encryption key

To derive the key used for encrypting and decrypting local communications between the terminal and your POS app:

1. Make sure you know the identifier, passphrase, and version of the shared key that you set up in the Customer Area.

2. Derive the key, making sure to pass the values in string form exactly as they appear in the Customer Area.

   let encryptionKey = try EncryptionKey(
       identifier: "KEY_IDENTIFIER",
       passphrase: "KEY_PASSPHRASE",
       version: KEY_VERSION
   )

Once the key is derived, you are ready to encrypt your local communications.

Encrypt and decrypt communications

1. Create your request. For example, create a Message<PaymentRequest>.

2. Encrypt your request.

   let encryptionKey: EncryptionKey = // the key you derived earlier
   let request: Message<PaymentRequest> = // the payment request you created
   let encryptedMessage: Data = try request.encrypt(using: encryptionKey)

3. Send the encryptedMessage to the terminal.

4. When you receive the response from the terminal, decrypt the response.

   let key: EncryptionKey = // the key you derived earlier
   let response: Data = // the response you receive from the terminal
   let encryptedMessage: EncryptedMessage = try Coder.decode(EncryptedMessage.self, from: response)
   let decryptedMessage: Message<PaymentResponse> = try decrypt(PaymentResponse.self, using: key)

Before you begin

• Make sure you have:
  • Installed our Java library in your project.
  • Installed Adyen's root certificate.
  • Set up a shared key.

Use the Java library

1. In your Java project, create a Config object, specifying:

   • Your merchant account.
   • The path to Adyen's root certificate.
   • The URL of the terminal without the :8443/nexo part.

   Config config = new Config();
   config.setMerchantAccount("Your merchant account");
   config.setTerminalCertificate("Local path to the Adyen root certificate");
   config.setTerminalApiLocalEndpoint("URL of the terminal, for example https://192.168.68.117, WITHOUT the port/nexo part :8443/nexo/");

2. Create a Client object using the Config object created in the previous step, and setting the environment to TEST or LIVE.

   Client terminalLocalAPIClient = new Client(config);
   terminalLocalAPIClient.setEnvironment(Environment.TEST, null);

3. Create the TerminalLocalAPI service using the client created in the previous step.

   TerminalLocalAPI terminalLocalAPI = new TerminalLocalAPI(terminalLocalAPIClient);

4. Create a SecurityKey object specifying the identifier, passphrase, and version of your shared key.

   SecurityKey securityKey = new SecurityKey();
   securityKey.setAdyenCryptoVersion(1);
   securityKey.setKeyIdentifier("Key identifier");
   securityKey.setPassphrase("Key passphrase");
   securityKey.setKeyVersion(1);

5. When you send a Terminal API request to the payment terminal, use the TerminalLocalAPI service specifying a TerminalApiRequest object and the SecurityKey object.

   TerminalAPIResponse terminalAPIResponse = terminalLocalAPI.request(terminalApiRequest, securityKey);

Before you begin

• Make sure you have:
  • Installed our Node library in your project.
  • Installed Adyen's root certificate.
  • Set up a shared key.

Use the Node library

1. In your Node project, create a Config object, specifying:

   • Your merchant account.
   • The path to Adyen's root certificate.
   • The URL of the terminal without the :8443/nexo part.

   const config: Config = new Config();
   config.merchantAccount = "Your merchant account";
   config.certificatePath = "Local path to the Adyen root certificate";
   config.terminalApiLocalEndpoint = "URL of the terminal, for example https://192.168.68.117, WITHOUT the port/nexo part :8443/nexo/";

2. Create a Client object using the config object created in the previous step, and setting the environment to TEST or LIVE.

   const client = new Client({ config });
   client.setEnvironment("TEST");

3. Create the TerminalLocalAPI service using the client created in the previous step.

   const terminalLocalAPI = new TerminalLocalAPI(client);

4. Create a SecurityKey object specifying the identifier, passphrase, and version of your shared key.

   const securityKey: SecurityKey = {
       adyenCryptoVersion: 1,
       keyIdentifier:"Key identifier",
       keyVersion: 1,
       passphrase: "Key passphrase",
   };

5. When you send a Terminal API request to the payment terminal, use the TerminalLocalAPI service specifying a TerminalApiRequest object and the SecurityKey object.

   const terminalApiResponse: TerminalApiResponse =
    await terminalLocalAPI.request(terminalAPIPaymentRequest, securityKey);