Add chargeType into charge request and charge response

rave-shift4 · rave-shift4 · commit bc91b6d39454 · 2025-12-15T18:04:39.000+01:00
diff --git a/src/main/java/com/shift4/enums/ChargeType.java b/src/main/java/com/shift4/enums/ChargeType.java
@@ -0,0 +1,42 @@
+package com.shift4.enums;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+public enum ChargeType {
+    FIRST_RECURRING("first_recurring"),
+    SUBSEQUENT_RECURRING("subsequent_recurring"),
+    MERCHANT_INITIATED("merchant_initiated"),
+    CUSTOMER_INITIATED("customer_initiated"),
+
+    /**
+     * Used when received value can't be mapped to this enumeration.
+     */
+    UNRECOGNIZED("unrecognized"),
+    ;
+
+    private final String value;
+
+    ChargeType(String value) {
+        this.value = value;
+    }
+
+    @JsonCreator
+    public static ChargeType fromValue(String value) {
+        if (value == null) {
+            return null;
+        }
+        for (ChargeType type : values()) {
+            if (type.value.equalsIgnoreCase(value)) {
+                return type;
+            }
+        }
+
+        return UNRECOGNIZED;
+    }
+
+    @JsonValue
+    public String getValue() {
+        return value;
+    }
+}
diff --git a/src/main/java/com/shift4/request/ChargeRequest.java b/src/main/java/com/shift4/request/ChargeRequest.java
@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.shift4.enums.ChargeType;
 import com.shift4.response.Customer;
 
 import java.util.HashMap;
@@ -20,6 +21,7 @@ public class ChargeRequest {
 	private CardRequest card;
 	private PaymentMethodRequest paymentMethod;
 	private ChargeFlowRequest flow;
+    private ChargeType type;
 	private Boolean captured;
 	private ShippingRequest shipping;
 	private BillingRequest billing;
@@ -65,7 +67,11 @@ public ChargeFlowRequest getFlow() {
 		return flow;
 	}
 
-	public Boolean getCaptured() {
+    public ChargeType getType() {
+        return type;
+    }
+
+    public Boolean getCaptured() {
 		return captured;
 	}
 
@@ -128,7 +134,12 @@ public ChargeRequest flow(ChargeFlowRequest flow) {
 		return this;
 	}
 
-	public ChargeRequest captured(Boolean captured) {
+    public ChargeRequest type(ChargeType type) {
+        this.type = type;
+        return this;
+    }
+
+    public ChargeRequest captured(Boolean captured) {
 		this.captured = captured;
 		return this;
 	}
diff --git a/src/main/java/com/shift4/response/Charge.java b/src/main/java/com/shift4/response/Charge.java
@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.shift4.enums.ChargeStatus;
+import com.shift4.enums.ChargeType;
 import com.shift4.enums.ErrorCode;
 import com.shift4.util.Shift4Utils;
 
@@ -20,7 +21,8 @@ public class Charge {
 	private String currency;
 	private String description;
 	private ChargeStatus status;
-	private Card card;
+    private ChargeType type;
+    private Card card;
 	private PaymentMethod paymentMethod;
 	private ChargeFlow flow;
 	private String customerId;
@@ -80,7 +82,11 @@ public ChargeStatus getStatus() {
 		return status;
 	}
 
-	public Card getCard() {
+    public ChargeType getType() {
+        return type;
+    }
+
+    public Card getCard() {
 		return card;
 	}
 
diff --git a/src/test/java/com/shift4/ChargesTest.java b/src/test/java/com/shift4/ChargesTest.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.shift4.enums.ChargeStatus;
+import com.shift4.enums.ChargeType;
 import com.shift4.enums.ErrorType;
 import com.shift4.exception.Shift4Exception;
 import com.shift4.request.ChargeListRequest;
@@ -141,4 +142,14 @@ void shouldCreateChargeUsingExplicitMerchant() {
         assertThat(retrievedCharge.getCurrency()).isEqualTo(request.getCurrency());
         assertThat(retrievedCharge.getFailureCode()).isNull();
     }
+
+    @Test
+    void shouldSendChargeType() {
+        // given
+        ChargeRequest request = charge().card(successCard()).type(ChargeType.CUSTOMER_INITIATED);
+        // when
+        Charge charge = gateway.createCharge(request);
+        // then
+        assertThat(charge.getType()).isEqualTo(ChargeType.CUSTOMER_INITIATED);
+    }
 }
