Add alternative payment methods support (like Google Pay)

Author: OlegGS

.github/workflows/maven.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [ 11, 17, 21 ]
+        java: [ 11, 17, 21, 25 ]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -12,14 +12,14 @@ This library provide ability to make requests to Transact Pro Gateway API v3.
 <dependency>
   <groupId>com.github.transactpro</groupId>
   <artifactId>gateway</artifactId>
-  <version>2.0.1</version>
+  <version>2.0.2</version>
 </dependency>
 ```
 
 #### Gradle
 
 ```groovy
-implementation 'com.github.transactpro:gateway:2.0.1'
+implementation 'com.github.transactpro:gateway:2.0.2'
 ```
 
 ## Documentation
@@ -214,6 +214,37 @@ Command command = new Command()
 sms.setCommand(command);
 ```
 
+### Using alternative payment methods
+
+To use an alternative payment method (like Google Pay), send a received token AS-IS or data from a decrypted token.
+
+```java
+// set a corresponding flag that indicates a token provider
+Command command = new Command().setPaymentMethodType(PaymentMethodType.PAYMENT_METHOD_TYPE_GOOGLE_PAY);
+operation.setCommand(command);
+
+// option 1: send received token AS-IS
+PaymentMethod paymentMethod = new PaymentMethod().setToken('<token>');
+operation.setPayment(paymentMethod);
+
+// option 2: send data from decrypted token
+ExternalTokenData externalTokenData = new ExternalTokenData()
+        .setCryptogram("<cryptogram from token>") // if available
+        .setEci("<ECI from token>") // if available
+        .setTransStatus("<transStatus from token>") // available for Click to Pay
+        .setDsTransId("<dsTransId from token>") // available for Click to Pay
+        .setAcsTransId("<acsTransId from token>") // available for Click to Pay
+        .setCardHolderAuthenticated(decryptedToken.paymentMethodDetails.assuranceDetails.cardHolderAuthenticated); // for Google Pay
+
+PaymentMethod paymentMethod = new PaymentMethod()
+        .setPan("<card number>")
+        .setExpMmYy("<card expiry>")
+        .setCardHolderName("<cardholder name>") // if available
+        .setExternalTokenData(externalTokenData);
+
+operation.setPayment(paymentMethod);
+```
+
 ### Callback validation
 
 ```java

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.transactpro</groupId>
     <artifactId>gateway</artifactId>
-    <version>2.0.1</version>
+    <version>2.0.2</version>
 
     <name>Transact Pro Gateway v3 Java client library</name>
     <description>A library that provide ability to make requests to Transact Pro Gateway API v3.</description>

src/main/java/com/github/transactpro/gateway/Gateway.java

@@ -33,6 +33,7 @@ public class Gateway {
     private String url;
     @Getter
     private final Authorization authorization;
+    @Setter
     private CloseableHttpClient httpClient;
     private Validator validator;
 

src/main/java/com/github/transactpro/gateway/adapters/PaymentMethodTypeSerializer.java

@@ -0,0 +1,15 @@
+package com.github.transactpro.gateway.adapters;
+
+import com.github.transactpro.gateway.model.request.data.command.PaymentMethodType;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonSerializationContext;
+import com.google.gson.JsonSerializer;
+
+import java.lang.reflect.Type;
+
+public class PaymentMethodTypeSerializer implements JsonSerializer<PaymentMethodType> {
+    @Override
+    public JsonElement serialize(PaymentMethodType paymentMethodType, Type type, JsonSerializationContext jsonSerializationContext) {
+        return jsonSerializationContext.serialize(paymentMethodType.getValue());
+    }
+}

src/main/java/com/github/transactpro/gateway/model/request/data/Command.java

@@ -3,6 +3,7 @@
 
 import com.github.transactpro.gateway.model.request.data.command.CardVerificationMode;
 import com.github.transactpro.gateway.model.request.data.command.PaymentMethodDataSource;
+import com.github.transactpro.gateway.model.request.data.command.PaymentMethodType;
 import com.github.transactpro.gateway.validation.base.CommandTransactionIdGroup;
 import jakarta.validation.constraints.NotNull;
 import lombok.Getter;
@@ -23,4 +24,5 @@ public class Command {
     private CardVerificationMode cardVerification;
     private PaymentMethodDataSource paymentMethodDataSource;
     private String paymentMethodDataToken;
+    private PaymentMethodType paymentMethodType;
 }

src/main/java/com/github/transactpro/gateway/model/request/data/PaymentMethod.java

@@ -1,9 +1,8 @@
 package com.github.transactpro.gateway.model.request.data;
 
 import com.github.transactpro.gateway.model.request.data.payment.ExternalMPIData;
-import com.github.transactpro.gateway.validation.base.PaymentMethodPanExpGroup;
+import com.github.transactpro.gateway.model.request.data.payment.ExternalTokenData;
 import jakarta.validation.Valid;
-import jakarta.validation.constraints.NotNull;
 import lombok.Getter;
 import lombok.Setter;
 import lombok.experimental.Accessors;
@@ -15,13 +14,15 @@
 public class PaymentMethod {
 
     @CreditCardNumber(ignoreNonDigitCharacters = true)
-    @NotNull(groups = PaymentMethodPanExpGroup.class)
     private String pan;
-    @NotNull(groups = PaymentMethodPanExpGroup.class)
     private String expMmYy;
     private String cvv;
     private String cardholderName;
+    private String token;
 
     @Valid
     private ExternalMPIData externalMpiData;
+
+    @Valid
+    private ExternalTokenData externalTokenData;
 }

src/main/java/com/github/transactpro/gateway/model/request/data/command/PaymentMethodType.java

@@ -0,0 +1,17 @@
+package com.github.transactpro.gateway.model.request.data.command;
+
+import lombok.Getter;
+
+@Getter
+public enum PaymentMethodType {
+    PAYMENT_METHOD_TYPE_CARD("cc"),
+    PAYMENT_METHOD_TYPE_GOOGLE_PAY("google_pay"),
+    PAYMENT_METHOD_TYPE_APPLE_PAY("apple_pay"),
+    PAYMENT_METHOD_TYPE_CLICK2PAY("click2pay");
+
+    private final String value;
+
+    PaymentMethodType(String value) {
+        this.value = value;
+    }
+}

src/main/java/com/github/transactpro/gateway/model/request/data/payment/ExternalTokenData.java

@@ -0,0 +1,22 @@
+package com.github.transactpro.gateway.model.request.data.payment;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+@Getter
+@Setter
+@Accessors(chain = true)
+public class ExternalTokenData {
+    private String cryptogram;
+    private String eci;
+    @SerializedName("transStatus")
+    private String transStatus;
+    @SerializedName("dsTransID")
+    private String dsTransID;
+    @SerializedName("acsTransID")
+    private String acsTransID;
+    @SerializedName("cardHolderAuthenticated")
+    private Boolean cardHolderAuthenticated;
+}

src/main/java/com/github/transactpro/gateway/operation/Operation.java

@@ -2,10 +2,12 @@
 
 import com.github.transactpro.gateway.adapters.CardVerificationModeSerializer;
 import com.github.transactpro.gateway.adapters.PaymentMethodDataSourceSerializer;
+import com.github.transactpro.gateway.adapters.PaymentMethodTypeSerializer;
 import com.github.transactpro.gateway.model.Request;
 import com.github.transactpro.gateway.model.Response;
 import com.github.transactpro.gateway.model.request.data.command.CardVerificationMode;
 import com.github.transactpro.gateway.model.request.data.command.PaymentMethodDataSource;
+import com.github.transactpro.gateway.model.request.data.command.PaymentMethodType;
 import com.google.gson.FieldNamingPolicy;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
@@ -21,6 +23,7 @@ public abstract class Operation<ResponseT> implements Operable {
     @Getter
     protected String requestUri;
 
+    @Getter
     protected Request request;
     protected Class<ResponseT> responseType;
     @Getter
@@ -41,15 +44,12 @@ protected Request buildRequest() {
         return new Request();
     }
 
-    public Request getRequest() {
-        return request;
-    }
-
     protected Gson buildJsonParser() {
         return new GsonBuilder()
                 .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES)
                 .registerTypeAdapter(CardVerificationMode.class, new CardVerificationModeSerializer())
                 .registerTypeAdapter(PaymentMethodDataSource.class, new PaymentMethodDataSourceSerializer())
+                .registerTypeAdapter(PaymentMethodType.class, new PaymentMethodTypeSerializer())
                 .create();
     }