Merge pull request #1126 from Adyen/automation/release

Release v21.4.0

.github/workflows/codeql-analysis.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/coveralls.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK 11
         uses: actions/setup-java@v3
         with:

.github/workflows/javaci.yml

@@ -9,7 +9,7 @@ jobs:
       matrix:
         java: [ '11', '17', '20' ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK ${{ matrix.Java }}
         uses: actions/setup-java@v3
 

.github/workflows/models.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Generate Models
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: make models
       - name: Set PR variables
         id: vars

.github/workflows/publish.yml

@@ -8,7 +8,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up JDK 11
       uses: actions/setup-java@v3
       with:

.github/workflows/services.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Generate Models + Services
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: make services
       - name: Set PR variables
         id: vars

README.md

@@ -58,7 +58,7 @@ You can use Maven and add this dependency to your project's POM:
 <dependency>
   <groupId>com.adyen</groupId>
   <artifactId>adyen-java-api-library</artifactId>
-  <version>21.3.0</version>
+  <version>21.4.0</version>
 </dependency>
 ```
 
@@ -224,6 +224,202 @@ System.setProperty("https.proxyUser", "squid");
 System.setProperty("https.proxyPassword", "ward");
 ~~~~
 
+## Using the Cloud Terminal API Integration
+In order to submit In-Person requests with [Terminal API over Cloud](https://docs.adyen.com/point-of-sale/design-your-integration/choose-your-architecture/cloud/) you need to initialize the client in a similar way as the steps listed above for Ecommerce transactions, but make sure to include `TerminalCloudAPI`:
+``` java
+// Step 1: Import the required classes
+import com.adyen.Client;
+import com.adyen.enums.Environment;
+import com.adyen.service.TerminalCloudAPI;
+import com.adyen.model.nexo.*;
+import com.adyen.model.terminal.*;
+
+// Step 2: Initialize the client object
+Client client = new Client("Your YOUR_API_KEY", Environment.TEST);
+
+// Step 3: Initialize the API object
+TerminalCloudAPI terminalCloudApi = new TerminalCloudAPI(client);
+
+// Step 4: Create the request object
+String serviceID = "123456789";
+String saleID = "POS-SystemID12345";
+String POIID = "Your Device Name(eg V400m-123456789)";
+
+// Use a unique transaction for every other transaction you perform
+String transactionID = "TransactionID";
+TerminalAPIRequest terminalAPIRequest = new TerminalAPIRequest();
+SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
+
+MessageHeader messageHeader = new MessageHeader();
+messageHeader.setMessageClass(MessageClassType.SERVICE);
+messageHeader.setMessageCategory(MessageCategoryType.PAYMENT);
+messageHeader.setMessageType(MessageType.REQUEST);
+messageHeader.setProtocolVersion("3.0");
+messageHeader.setServiceID(serviceID);
+messageHeader.setSaleID(saleID);        
+messageHeader.setPOIID(POIID);        
+
+saleToPOIRequest.setMessageHeader(messageHeader);
+
+com.adyen.model.nexo.PaymentRequest paymentRequest = new com.adyen.model.nexo.PaymentRequest();   
+SaleData saleData = new SaleData();
+TransactionIdentification transactionIdentification = new TransactionIdentification();
+transactionIdentification.setTransactionID("001");
+XMLGregorianCalendar timestamp = DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar());
+transactionIdentification.setTimeStamp(timestamp);
+saleData.setSaleTransactionID(transactionIdentification);
+
+SaleToAcquirerData saleToAcquirerData = new SaleToAcquirerData();
+ApplicationInfo applicationInfo = new ApplicationInfo();
+CommonField merchantApplication = new CommonField();
+merchantApplication.setVersion("1");
+merchantApplication.setName("Test");
+applicationInfo.setMerchantApplication(merchantApplication);
+saleToAcquirerData.setApplicationInfo(applicationInfo);
+saleData.setSaleToAcquirerData(saleToAcquirerData);
+
+PaymentTransaction paymentTransaction = new PaymentTransaction();
+AmountsReq amountsReq = new AmountsReq();
+amountsReq.setCurrency("EUR");
+amountsReq.setRequestedAmount(BigDecimal.valueOf(1000));
+paymentTransaction.setAmountsReq(amountsReq);
+
+paymentRequest.setPaymentTransaction(paymentTransaction);
+paymentRequest.setSaleData(saleData);
+
+saleToPOIRequest.setPaymentRequest(paymentRequest);
+
+terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);
+
+// Step 5: Make the request
+TerminalAPIResponse terminalAPIResponse = terminalCloudApi.sync(terminalAPIRequest);
+```
+
+### Optional: perform an abort request
+
+To perform an [abort request](https://docs.adyen.com/point-of-sale/basic-tapi-integration/cancel-a-transaction/) you can use the following example:
+``` java
+TerminalAPIRequest terminalAPIRequest = new TerminalAPIRequest();
+SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
+
+MessageHeader messageHeader = new MessageHeader();
+messageHeader.setMessageClass(MessageClassType.SERVICE);
+messageHeader.setMessageCategory(MessageCategoryType.ABORT);
+messageHeader.setMessageType(MessageType.REQUEST);
+messageHeader.setProtocolVersion("3.0");
+messageHeader.setServiceID("Different service ID");
+messageHeader.setSaleID(saleID);        
+messageHeader.setPOIID(POIID);
+
+AbortRequest abortRequest = new AbortRequest();
+abortRequest.setAbortReason("MerchantAbort");
+MessageReference messageReference = new MessageReference();
+messageReference.setMessageCategory(MessageCategoryType.PAYMENT);
+messageReference.setSaleID(saleID);
+messageReference.setPOIID(POIID);
+// Service ID of the payment you're aborting
+messageReference.setServiceID(serviceID);
+abortRequest.setMessageReference(messageReference);
+
+saleToPOIRequest.setAbortRequest(abortRequest);
+saleToPOIRequest.setMessageHeader(messageHeader);
+
+terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);
+
+TerminalAPIResponse terminalAPIResponse = terminalCloudApi.sync(terminalAPIRequest);
+```
+
+### Optional: perform a status request
+
+To perform a [status request](https://docs.adyen.com/point-of-sale/basic-tapi-integration/verify-transaction-status/) you can use the following example:
+```java
+TerminalAPIRequest terminalAPIRequest = new TerminalAPIRequest();
+SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
+
+MessageHeader messageHeader = new MessageHeader();
+messageHeader.setMessageClass(MessageClassType.SERVICE);
+messageHeader.setMessageCategory(MessageCategoryType.TRANSACTION_STATUS);
+messageHeader.setMessageType(MessageType.REQUEST);
+messageHeader.setProtocolVersion("3.0");
+messageHeader.setServiceID("Different service ID");
+messageHeader.setSaleID(saleID);        
+messageHeader.setPOIID(POIID);
+
+TransactionStatusRequest transactionStatusRequest = new TransactionStatusRequest();
+transactionStatusRequest.setReceiptReprintFlag(true);
+transactionStatusRequest.getDocumentQualifier().add(DocumentQualifierType.CASHIER_RECEIPT);
+transactionStatusRequest.getDocumentQualifier().add(DocumentQualifierType.CUSTOMER_RECEIPT);
+MessageReference messageReference = new MessageReference();
+messageReference.setMessageCategory(MessageCategoryType.PAYMENT);
+messageReference.setSaleID(saleID);
+// serviceID of the transaction you want the status update from
+messageReference.setServiceID(serviceID);
+transactionStatusRequest.setMessageReference(messageReference);
+
+saleToPOIRequest.setTransactionStatusRequest(transactionStatusRequest);
+saleToPOIRequest.setMessageHeader(messageHeader);
+
+terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);
+
+TerminalAPIResponse terminalAPIResponse = terminalCloudApi.sync(terminalAPIRequest);
+```
+
+## Using the Local Terminal API Integration
+The request and response payloads are identical to the Cloud Terminal API, however, additional encryption details are required to perform the requests.
+```java
+// Step 1: Import the required classes
+import com.adyen.service.TerminalLocalAPI;
+import com.adyen.model.nexo.*;
+import com.adyen.model.terminal.*;
+
+// Step 2: Add your Certificate Path and Local Endpoint to the config path. Install the certificate from [here](https://docs.adyen.com/point-of-sale/choose-your-architecture/local#protect-communications).
+Client client = new Client();
+client.getConfig().setTerminalApiLocalEndpoint("The IP of your terminal (eg https://192.168.47.169)");
+client.getConfig().setEnvironment(Environment.TEST);
+client.getConfig().setTerminalCertificate("YOUR_CERTIFICATE_PATH");
+
+// Step 3: Setup a security password for you terminal in CA, and import the security key object:
+SecurityKey securityKey = new SecurityKey();
+securityKey.setKeyVersion(1);
+securityKey.setAdyenCryptoVersion(1);
+securityKey.setKeyIdentifier("keyIdentifier");
+securityKey.setPassphrase("passphrase");
+
+// Step 4 Initialize the API object
+TerminalLocalAPI terminalLocalAPI = new TerminalLocalAPI(client, securityKey);
+
+// Step 5: Create the request object
+TerminalAPIRequest terminalAPIRequest = ///....same as the one used for Cloud API ;
+
+// Step 6: Make the request
+TerminalAPIResponse terminalAPIResponse = terminalLocalApi.request(terminalAPIRequest);
+```
+
+## Using the Local Terminal API Integration without Encryption (Only on TEST)
+If you wish to develop the Local Terminal API integration parallel to your encryption implementation, you can opt for the unencrypted version. Be sure to remove any encryption details from the CA terminal config page.
+```java
+// Step 1: Import the required classes
+import com.adyen.service.TerminalLocalAPIUnencrypted;
+import com.adyen.model.nexo.*;
+import com.adyen.model.terminal.*;
+
+// Step 2: Add your Certificate Path and Local Endpoint to the config path.
+Client client = new Client();
+client.getConfig().setTerminalApiLocalEndpoint("The IP of your terminal (eg https://192.168.47.169)");
+client.getConfig().setEnvironment(Environment.TEST);
+client.getConfig().setTerminalCertificate("YOUR_CERTIFICATE_PATH");
+
+// Step 3 Initialize the client and the API objects;
+TerminalLocalAPIUnencrypted terminalLocalAPIUnencrypted = new TerminalLocalAPIUnencrypted(client);
+
+// Step 4: Create the request object
+TerminalAPIRequest terminalAPIPaymentRequest = ///....same as the one used in the other examples;
+
+// Step 5: Make the request
+TerminalAPIResponse terminalAPIResponse = terminalLocalAPIUnencrypted.request(terminalAPIPaymentRequest);
+```
+
+
 ### Example integrations
 
 For a closer look at how our Java library works, you can clone one of our example integrations:

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.adyen</groupId>
     <artifactId>adyen-java-api-library</artifactId>
     <packaging>jar</packaging>
-    <version>21.3.0</version>
+    <version>21.4.0</version>
     <name>Adyen Java API Library</name>
     <description>Adyen API Client Library for Java</description>
     <url>https://github.com/adyen/adyen-java-api-library</url>
@@ -104,7 +104,7 @@
                 <configuration>
                     <source>8</source>
                 </configuration>
-                <version>3.5.0</version>
+                <version>3.6.0</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -230,7 +230,7 @@
         <dependency>
             <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations</artifactId>
-            <version>2.2.15</version>
+            <version>2.2.16</version>
             <scope>compile</scope>
         </dependency>
         <dependency>

src/main/java/com/adyen/Client.java

@@ -1,23 +1,3 @@
-/*
- *                       ######
- *                       ######
- * ############    ####( ######  #####. ######  ############   ############
- * #############  #####( ######  #####. ######  #############  #############
- *        ######  #####( ######  #####. ######  #####  ######  #####  ######
- * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
- * ###### ######  #####( ######  #####. ######  #####          #####  ######
- * #############  #############  #############  #############  #####  ######
- *  ############   ############  #############   ############  #####  ######
- *                                      ######
- *                               #############
- *                               ############
- *
- * Adyen Java API Library
- *
- * Copyright (c) 2021 Adyen B.V.
- * This file is open source and available under the MIT license.
- * See the LICENSE file for more info.
- */
 package com.adyen;
 
 import com.adyen.enums.Environment;
@@ -31,7 +11,7 @@ public class Client {
     private ClientInterface httpClient;
     private Config config;
     public static final String LIB_NAME = "adyen-java-api-library";
-    public static final String LIB_VERSION = "21.3.0";
+    public static final String LIB_VERSION = "21.4.0";
     public static final String TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
     public static final String TERMINAL_API_ENDPOINT_LIVE = "https://terminal-api-live.adyen.com";
 

src/main/java/com/adyen/Config.java

@@ -1,23 +1,3 @@
-/*
- *                       ######
- *                       ######
- * ############    ####( ######  #####. ######  ############   ############
- * #############  #####( ######  #####. ######  #############  #############
- *        ######  #####( ######  #####. ######  #####  ######  #####  ######
- * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
- * ###### ######  #####( ######  #####. ######  #####          #####  ######
- * #############  #############  #############  #############  #####  ######
- *  ############   ############  #############   ############  #####  ######
- *                                      ######
- *                               #############
- *                               ############
- *
- * Adyen Java API Library
- *
- * Copyright (c) 2018 Adyen B.V.
- * This file is open source and available under the MIT license.
- * See the LICENSE file for more info.
- */
 package com.adyen;
 
 import com.adyen.enums.Environment;