Implement Ingenico terminal

src/GlobalPayments.Api/Entities/Enums.cs

@@ -55,7 +55,32 @@ public enum DeviceType {
         /// <summary>
         /// Indicates a genius terminal
         /// </summary>
-        GENIUS
+        GENIUS,
+
+        /// <summary>
+        /// Indicates an Ingenico Desk/5000 terminal underlying in Epos software package.
+        /// </summary>
+        Ingenico_EPOS_Desk5000,
+
+        /// <summary>
+        /// Indicates an Ingenico Lane/3000 terminal underlying in Epos software package.
+        /// </summary>
+        Ingenico_EPOS_Lane3000,
+
+        /// <summary>
+        /// Indicates an Ingenico Move/3500 terminal underlying in Epos software package.
+        /// </summary>
+        Ingenico_EPOS_Move3500
+    }
+
+    /// <summary>
+    /// Indicates a device mode.
+    /// </summary>
+    public enum DeviceMode {
+        /// <summary>
+        /// For devices that supports Pay@Table functionalities.
+        /// </summary>
+        PAY_AT_TABLE
     }
 
     /// <summary>

src/GlobalPayments.Api/GlobalPayments.Api.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <VersionPrefix>3.0.0</VersionPrefix>
-    <TargetFramework>netstandard1.3</TargetFramework>
+    <TargetFramework>netstandard2.0</TargetFramework>
     <AssemblyName>GlobalPayments.Api</AssemblyName>
     <PackageId>GlobalPayments.Api</PackageId>
     <NetStandardImplicitPackageVersion>1.6.1</NetStandardImplicitPackageVersion>
@@ -18,7 +18,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="CoreCompat.System.Drawing" Version="1.0.0-beta006" />
+    <PackageReference Include="System.Drawing.Common" Version="4.7.0" />
+    <PackageReference Include="System.IO.Ports" Version="4.7.0" />
+    <PackageReference Include="System.Management" Version="4.7.0" />
     <PackageReference Include="System.Net.Requests" Version="4.3.0" />
     <PackageReference Include="System.Net.Sockets" Version="4.3.0" />
     <PackageReference Include="System.Security.Cryptography.Algorithms" Version="4.3.0" />
@@ -29,4 +31,8 @@
     <PackageReference Include="System.Net.Primitives" Version="4.3.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Update="NETStandard.Library" Version="2.0.3" />
+  </ItemGroup>
+
 </Project>

src/GlobalPayments.Api/Terminals/Abstractions/IDeviceCommInterface.cs

@@ -9,5 +9,9 @@ public interface IDeviceCommInterface {
         byte[] Send(IDeviceMessage message);
 
         event MessageSentEventHandler OnMessageSent;
+
+        event BroadcastMessageEventHandler OnBroadcastMessage;
+
+        event PayAtTableRequestEventHandler OnPayAtTableRequest;
     }
 }

src/GlobalPayments.Api/Terminals/Abstractions/IDeviceInterface.cs

@@ -2,14 +2,23 @@
 using GlobalPayments.Api.Entities;
 using GlobalPayments.Api.Terminals.Abstractions;
 using GlobalPayments.Api.Terminals.Builders;
+using GlobalPayments.Api.Terminals.Ingenico;
 using GlobalPayments.Api.Terminals.Messaging;
 
 namespace GlobalPayments.Api.Terminals {
     public interface IDeviceInterface : IDisposable {
         event MessageSentEventHandler OnMessageSent;
+        event BroadcastMessageEventHandler OnBroadcastMessage;
+        event PayAtTableRequestEventHandler OnPayAtTableRequest;
 
         #region Admin Calls
-        void Cancel();
+
+        /// <summary>
+        /// A method to Cancel a live transaction.
+        /// </summary>
+        /// <param name="amount">Amount to be passed for cancel request.</param>
+        /// <returns>TerminalManageBuilder</returns>
+        IDeviceResponse Cancel();
         IDeviceResponse CloseLane();
         IDeviceResponse DisableHostResponseBeep();
         ISignatureResponse GetSignatureFile();
@@ -24,10 +33,44 @@ public interface IDeviceInterface : IDisposable {
         ISAFResponse SendStoreAndForward();
         IDeviceResponse SetStoreAndForwardMode(bool enabled);
         IDeviceResponse StartCard(PaymentMethodType paymentMethodType);
+
+        /// <summary>
+        /// The terminal immediately initiates a duplicate of the last completed transaction
+        /// </summary>
+        /// <returns>IDeviceResponse</returns>
+        IDeviceResponse Duplicate();
+
+        /// <summary>
+        /// Command used to gain feedback as to the status of the terminal.
+        /// </summary>
+        /// <returns></returns>
+        IDeviceResponse GetTerminalStatus();
+
+        /// <summary>
+        /// Command used to request for CALL TMS in the terminal. 
+        /// </summary>
+        /// <returns>IDeviceResponse</returns>
+        IDeviceResponse GetTerminalConfiguration();
+
+        IDeviceResponse TestConnection();
         #endregion
 
         #region reporting
         TerminalReportBuilder LocalDetailReport();
+        /// <summary>
+        /// Used to request the XML data for the last completed report that is stored in the terminal’s memory
+        /// </summary>
+        /// <param name="type">Receipt Type</param>
+        /// <returns></returns>
+        TerminalReportBuilder GetLastReceipt(ReceiptType type = ReceiptType.TICKET);
+
+        /// <summary>
+        /// Instruct the terminal to initiate report and stores it in terminal's memory. 
+        /// GetLastReceipt can be used to extract XML data after. 
+        /// </summary>
+        /// <param name="type">Report Type</param>
+        /// <returns></returns>
+        TerminalReportBuilder GetReport(Ingenico.ReportType type);
         #endregion
 
         #region Batch Calls
@@ -65,14 +108,59 @@ public interface IDeviceInterface : IDisposable {
 
         #region Generic Calls
         TerminalAuthBuilder AddValue(decimal? amount = null);
+
+        /// <summary>
+        /// Instructs the terminal to transact a pre-authorization transaction.
+        /// </summary>
+        /// <param name="amount">Amount</param>
+        /// <returns></returns>
         TerminalAuthBuilder Authorize(decimal? amount = null);
         TerminalAuthBuilder Balance();
         TerminalManageBuilder Capture(decimal? amount = null);
+
+        /// <summary>
+        /// Instruct the terminal to refund the last completed transaction.
+        /// </summary>
+        /// <param name="amount">Refund Amount</param>
+        /// <returns></returns>
         TerminalAuthBuilder Refund(decimal? amount = null);
+
+        /// <summary>
+        /// Instruct the terminal to process sale transaction.
+        /// </summary>
+        /// <param name="amount">Sale Amount</param>
+        /// <returns></returns>
         TerminalAuthBuilder Sale(decimal? amount = null);
+
+        /// <summary>
+        /// Verify the account of the card holder.
+        /// </summary>
+        /// <returns></returns>
         TerminalAuthBuilder Verify();
         TerminalManageBuilder Void();
         TerminalAuthBuilder Withdrawal(decimal? amount = null);
         #endregion
+
+        #region Terminal Management
+
+        /// <summary>
+        /// The terminal immediately performs a reversal of the last completed transaction if no Transaction Id is set.
+        /// </summary>
+        /// <param name="amount">Amount to be passed for cancel request.</param>
+        /// <returns>TerminalManageBuilder</returns>
+        TerminalManageBuilder Reverse(decimal? amount = null);
+
+        #endregion
+
+        #region Pay@Table Feature
+
+        /// <summary>
+        /// Response to terminal after Pay@Table request has been made.
+        /// </summary>
+        /// <param name="response"></param>
+        /// <returns></returns>
+        TerminalAuthBuilder PayAtTableResponse();
+
+        #endregion
     }
 }

src/GlobalPayments.Api/Terminals/Builders/TerminalAuthBuilder.cs

@@ -2,6 +2,7 @@
 using GlobalPayments.Api.Entities;
 using GlobalPayments.Api.PaymentMethods;
 using GlobalPayments.Api.Terminals.Abstractions;
+using GlobalPayments.Api.Terminals.Ingenico;
 
 namespace GlobalPayments.Api.Terminals.Builders {
     public class TerminalAuthBuilder : TerminalBuilder<TerminalAuthBuilder> {
@@ -10,8 +11,9 @@ public class TerminalAuthBuilder : TerminalBuilder<TerminalAuthBuilder> {
         internal decimal? Amount { get; set; }
         internal string AuthCode {
             get {
-                if (PaymentMethod is TransactionReference)
+                if (PaymentMethod is TransactionReference) {
                     return (PaymentMethod as TransactionReference).AuthCode;
+                }
                 return null;
             }
         }
@@ -30,11 +32,19 @@ internal string AuthCode {
         internal string TaxExemptId { get; set; }
         internal string TransactionId {
             get {
-                if (PaymentMethod is TransactionReference)
+                if (PaymentMethod is TransactionReference) {
                     return (PaymentMethod as TransactionReference).TransactionId;
+                }
                 return null;
             }
         }
+        internal string CurrencyCode { get; set; }
+        internal PaymentMode PaymentMode { get; set; }
+        internal string TableNumber { get; set; }
+        internal TaxFreeType? TaxFreeType { get; set; }
+        internal PATPaymentMode? AdditionalMessage { get; set; }
+        internal PATResponseType? PayAtTableResponse { get; private set; }
+        public string FilePath { get; private set; }
 
         public TerminalAuthBuilder WithAddress(Address address) {
             Address = address;
@@ -48,9 +58,16 @@ public TerminalAuthBuilder WithAmount(decimal? amount) {
             Amount = amount;
             return this;
         }
+
+        /// <summary>
+        /// Sets the authorization code for the transaction.
+        /// </summary>
+        /// <param name="value">Authorization Code</param>
+        /// <returns></returns>
         public TerminalAuthBuilder WithAuthCode(string value) {
-            if (PaymentMethod == null || !(PaymentMethod is TransactionReference))
+            if (PaymentMethod == null || !(PaymentMethod is TransactionReference)) {
                 PaymentMethod = new TransactionReference();
+            }
             (PaymentMethod as TransactionReference).AuthCode = value;
             return this;
         }
@@ -64,6 +81,12 @@ public TerminalAuthBuilder WithAutoSubstantiation(AutoSubstantiation value) {
             AutoSubstantiation = value;
             return this;
         }
+
+        /// <summary>
+        /// Sets the cash back for the transaction.
+        /// </summary>
+        /// <param name="amount"></param>
+        /// <returns></returns>
         public TerminalAuthBuilder WithCashBack(decimal? amount) {
             CashBackAmount = amount;
             return this;
@@ -126,9 +149,71 @@ public TerminalAuthBuilder WithTransactionId(string value) {
             return this;
         }
 
+        /// <summary>
+        /// Sets the currency code for the transaction.
+        /// </summary>
+        /// <param name="value">Currency Code</param>
+        /// <returns></returns>
+        public TerminalAuthBuilder WithCurrencyCode(string value) {
+            CurrencyCode = value;
+            return this;
+        }
+
+        /// <summary>
+        /// Sets the payment mode for the transaction.
+        /// </summary>
+        /// <param name="value">Payment Mode</param>
+        /// <returns></returns>
+        public TerminalAuthBuilder WithPaymentMode(PaymentMode value) {
+            PaymentMode = value;
+            return this;
+        }
+
+        public TerminalAuthBuilder WithPaymentMode(PATPaymentMode additionalMessage) {
+            AdditionalMessage = additionalMessage;
+            return this;
+        }
+
+        /// <summary>
+        /// Sets the table number for the transaction.
+        /// </summary>
+        /// <param name="value">Table Number</param>
+        /// <returns></returns>
+        public TerminalAuthBuilder WithTableNumber(string value) {
+            TableNumber = value;
+            return this;
+        }
+
+        /// <summary>
+        /// Method used for requesting a Tax Free Refund Payment type transaction.
+        /// </summary>
+        /// <param name="taxFreeType">
+        /// Payment Type of refund. Either Cash or Credit
+        /// </param>
+        /// <returns></returns>
+        public TerminalAuthBuilder WithTaxFree(TaxFreeType taxFreeType) {
+            TaxFreeType = taxFreeType;
+            return this;
+        }
+
+        public TerminalAuthBuilder WithPayAtTableResponseType(PATResponseType response) {
+            PayAtTableResponse = response;
+            return this;
+        }
+
+        public TerminalAuthBuilder WithXMLPath(string filePath) {
+            FilePath = filePath;
+            return this;
+        }
+
         internal TerminalAuthBuilder(TransactionType type, PaymentMethodType paymentType) : base(type, paymentType) {
         }
 
+        /// <summary>
+        /// Executes the transaction.
+        /// </summary>
+        /// <param name="configName"></param>
+        /// <returns></returns>
         public override ITerminalResponse Execute(string configName = "default") {
             base.Execute(configName);