Versioning Heartland-iOS-SDK for releasing

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 2.0.28 2024-11-19
+- iOS SDK: Adding background property to UPA
+- iOS SDK: Adding ClientTxnID to Response
+
 ## 2.0.27 2024-08-21
 - iOS SDK: Duplicated transaction due to Surcharge lookup result.
 

Heartland-iOS-SDK-SampleApp/Heartland-iOS-SDK-SampleApp/C2XTransactionsViewController.swift

@@ -61,6 +61,7 @@ class C2XTransactionsViewController: UIViewController {
     var isDeviceConnected: Bool = false
     var terminalRefNumber: String?
     var clientTransactionId: String?
+    var clientTxnID: String?
 
     var transactionId: String? {
         didSet {
@@ -486,6 +487,10 @@ extension C2XTransactionsViewController: HpsC2xDeviceDelegate, GMSTransactionDel
             print(" Status response: \(responseStatus)")
         }
 
+        if let clientTxnId = response.clientTxnId {
+            print("ClientTxnID: \(clientTxnId)")
+        }
+
         print(" Response: \(response)")
 
         if let surchargeRequested = response.surchargeRequested {
@@ -496,6 +501,7 @@ extension C2XTransactionsViewController: HpsC2xDeviceDelegate, GMSTransactionDel
 
             self.terminalRefNumber = response.terminalRefNumber
             self.clientTransactionId = response.clientTransactionId
+            self.clientTxnID = response.clientTxnId
 
             if mainTransaction != .capture {
                 self.transactionId = responseTransactionId

Heartland-iOS-SDK-SampleApp/Heartland-iOS-SDK-SampleApp/UpaTransactions/UpaTransactionProtocol.swift

@@ -60,7 +60,7 @@ extension UpaTransactionProtocol {
         let builder = HpsUpaSAFTransactionBuilder(with: device)
 
         let getSAFReport = HpsUpaGetSaf(
-            data: HpsUpaCommandPayload(command: "GetSAFReport", ecrId: "123", requestId: "123", data: HpsUpaGetSafData(params: HpsUpaGetSafDataReportOutput(reportOutput: "ReturnData")))
+            data: HpsUpaCommandPayload(command: "GetSAFReport", ecrId: "123", requestId: "123", data: HpsUpaGetSafData(params: HpsUpaGetSafDataReportOutput(reportOutput: "ReturnData", background: "true")))
         )
 
         builder.execute(request: getSAFReport) { ihpsDeviceResponse, hpsUpaSafResponse, error in

Heartland-iOS-SDK-SampleApp/Heartland-iOS-SDK-SampleAppTests/HpsUPASAFTests.swift

@@ -57,7 +57,7 @@ class HpsUPASAFTests: XCTestCase {
 
         let builder = HpsUpaSAFTransactionBuilder(with: device)
 
-        let sendSAF = HpsUpaGetSaf(data: HpsUpaCommandPayload(command: HpsUpaGetSafConstants.command, ecrId: "123", requestId: "123", data: HpsUpaGetSafData(params: HpsUpaGetSafDataReportOutput(reportOutput: "ReturnData"))))
+        let sendSAF = HpsUpaGetSaf(data: HpsUpaCommandPayload(command: HpsUpaGetSafConstants.command, ecrId: "123", requestId: "123", data: HpsUpaGetSafData(params: HpsUpaGetSafDataReportOutput(reportOutput: "ReturnData", background: "true"))))
 
         builder.execute(request: sendSAF) { response, safResponse, error in
             XCTAssertNotNil(response)

Heartland-iOS-SDK.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
     s.name             = "Heartland-iOS-SDK"
-    s.version          = "2.0.27"
+    s.version          = "2.0.28"
     s.summary          = "Secure Tokenized Payments by Heartland Payment Systems."
 
   # This description is used to generate tags and improve search results.

Heartland-iOS-SDK/Classes/Terminals/HPA/Models/ParserObject/ResponseObjects/BatchSummary.h

@@ -22,6 +22,7 @@
 @property(nonatomic,strong) NSString *saleAmount;
 @property(nonatomic,strong) NSString *returnCount;
 @property(nonatomic,strong) NSString *returnAmount;
+@property(nonatomic,strong) NSString *clientTxnId;
 
 -(id)initWithPayload:(id <HpaResposeInterface>)response;
 @end

Heartland-iOS-SDK/Classes/Terminals/HPA/Models/ParserObject/ResponseObjects/BatchSummary.m

@@ -52,6 +52,9 @@ -(id)initWithPayload:(id <HpaResposeInterface>)response {
     if([[batchdetails allKeys] containsObject:@"ReturnAmt"]) {
         self.returnAmount = [batchdetails valueForKey:@"ReturnAmt"];
     }
+    if([[batchdetails allKeys] containsObject:@"ClientTxnId"]) {
+        self.clientTxnId = [batchdetails valueForKey:@"ClientTxnId"];
+    }
     return self;
 }
 @end

Heartland-iOS-SDK/Classes/Terminals/HPA/Models/ParserObject/ResponseObjects/HpsHpaResponse.h

@@ -177,7 +177,7 @@
 @property (readonly,retain) CardSummaryRecord *CardSummaryRecord;
 @property (readonly,retain) TransactionSummaryRecord *TransactionSummaryRecord;
 @property (readonly,retain) NSString *CardholderName;
-
+@property (readonly,retain) NSString *ClientTxnID;
 
     //EOD
 @property (readonly,retain) NSString *Reversal;

Heartland-iOS-SDK/Classes/Terminals/HpsTerminalResponse.h

@@ -85,6 +85,7 @@
 @property (nonatomic) SurchargeEligibility *surchargeRequested;
 @property (nonatomic,strong) NSString *surchargeFee;
 @property (nonatomic,strong) NSString *surchargeAmount;
+@property (nonatomic,strong) NSString *clientTxnId;
 - (void) mapResponse:(id <HpaResposeInterface>) response;
 // @todo
 //+(HpsTerminalResponse*)terminalResponseFromVitalSDK:(TransactionResponse*)transactionResponse;

Heartland-iOS-SDK/Classes/Terminals/UPA/Builders/HpsUpaReturnBuilder.m

@@ -42,7 +42,7 @@ - (void) execute:(void(^)(HpsUpaResponse*, NSError*))responseBlock{
     if (self.transactionId != nil) {
         request.data.data.transaction.referenceNumber = self.transactionId;
     }
-    request.data.data.transaction.totalAmount = self.amount != nil ? [formatter stringFromNumber:[NSNumber numberWithDouble:[self.amount doubleValue]]] : nil;
+    request.data.data.transaction.totalAmount = self.amount != nil ? [[formatter stringFromNumber:[NSNumber numberWithDouble:[self.amount doubleValue]]] stringByReplacingOccurrencesOfString:@"," withString:@"."] : nil;
 
     if (self.details != nil) {
         request.data.data.transaction.invoiceNbr = self.details.invoiceNumber;

Heartland-iOS-SDK/Classes/Terminals/UPA/Builders/HpsUpaSaleBuilder.m

@@ -136,7 +136,7 @@ - (void) executeForUPAUSA:(void(^)(HpsUpaResponse*, NSString*, NSError*))respons
         request.data.data.transaction.allowDuplicate = self.allowDuplicate;
     }
 
-    request.data.data.transaction.baseAmount = baseAmount != nil ? [formatter stringFromNumber:[NSNumber numberWithDouble:[baseAmount doubleValue]]] : nil;
+    request.data.data.transaction.baseAmount = baseAmount != nil ? [[formatter stringFromNumber:[NSNumber numberWithDouble:[baseAmount doubleValue]]] stringByReplacingOccurrencesOfString:@"," withString:@"."] : nil;
     request.data.data.transaction.tipAmount =  self.gratuity != nil ? [formatter stringFromNumber:[NSNumber numberWithDouble:[self.gratuity doubleValue]]] : nil;
     request.data.data.transaction.taxAmount =  self.taxAmount != nil ? [formatter stringFromNumber:[NSNumber numberWithDouble:[self.taxAmount doubleValue]]] : nil;
 

Heartland-iOS-SDK/Classes/Terminals/UPA/Builders/StoreAndForward/Models/HpsUpaGetSaf.swift

@@ -6,7 +6,7 @@
 
 import Foundation
 
-struct HpsUpaGetSafConstants {
+public struct HpsUpaGetSafConstants {
     static let command = "GetSAFReport"
 }
 
@@ -32,8 +32,10 @@ public struct HpsUpaGetSafData: Codable {
 
 public struct HpsUpaGetSafDataReportOutput: Codable {
     public let reportOutput: String?
+    public let background: String?
 
-    public init(reportOutput: String?) {
+    public init(reportOutput: String?, background: String?) {
         self.reportOutput = reportOutput
+        self.background = background
     }
 }

Heartland-iOS-SDK/Classes/Terminals/UPA/Models/HpsUpaResponse.m

@@ -85,6 +85,10 @@ -(id)initWithJSONDoc:(JsonDoc*)response
         self.partialApproval = [host getValueAsString:@"partialApproval"];
         self.batchId = [host getValueAsString:@"batchId"];
         self.cardBrandTransactionId = [host getValueAsString:@"cardBrandTransId"];
+
+        if ([host has:@"clientTxnId"]) {
+            self.clientTxnId = [host getValueAsString:@"clientTxnId"];;
+        }
 
         if ([host has:@"cashbackAmount"]) {
             self.cashBackAmount = [NSDecimalNumber decimalNumberWithString:[host getValueAsString:@"cashbackAmount"]];

Heartland-iOS-SDK/Classes/Terminals/Utility/GlobalMobileSDK/GMSResponseHelper.swift

@@ -11,6 +11,7 @@ class GMSResponseHelper {
 
         data.responseText = resp?.gatewayResponseText
         data.deviceResponseCode = deviceResponseCode
+        data.clientTxnId = resp?.clientTxnID
 
         return data
     }
@@ -68,7 +69,7 @@ class GMSResponseHelper {
         data.responseText = resp?.gatewayResponseText
         data.issuerRspCode = resp?.emvIssuerRspCode
 //        data.issuerRspMsg = resp?.hostProcessingResult?.emvIssuerAuthenticationData
-
+        data.clientTxnId = resp?.clientTxnID
         if let uintValue = resp?.tip {
             data.tipAmount = uintToDecimal(uintValue)
         }
@@ -184,6 +185,7 @@ class GMSResponseHelper {
         data.issuerRspMsg = resp?.hostProcessingResult?.emvIssuerAuthenticationData
         data.authCode = resp?.authCode
         data.authCodeData = resp?.authCodeData
+        data.clientTxnId = resp?.clientTxnID
         if let uintValue = resp?.tip {
             data.tipAmount = uintToDecimal(uintValue)
         }

Heartland-iOS-SDK/Classes/Terminals/Utility/GlobalMobileSDK/GMSWrapper.swift

@@ -225,6 +225,7 @@ extension GMSWrapper: TransactionDelegate {
 
         data.transactionId = response?.gatewayTransactionId
         data.clientTransactionId = response?.transactionId
+        data.clientTxnId = response?.clientTxnID
 
         if let uintValue = response?.approvedAmount {
             data.approvedAmount = GMSResponseHelper.uintToDecimal(uintValue)