.NET SDK

Overview

The .NET Payment Engine SDK provides an easy way for developers to integrate card-present and card-not-present payment processing into their .NET projects. Our SDK is designed with user-friendly payment functions and compatibility with a broad range of payment hardware, removing the need for complicated device integration. With this SDK, you can easily incorporate its advanced payment processing capabilities into your .NET projects, streamlining your payment processing experience.

Getting Started

Download and reference SDK files

1. Download & Run

   • Download the Updater app.

   • Right-click the file and Run as Administrator.

2. Enter Software Name

   • When prompted, type: paymentengine

3. Select SDK Specifications

   • Choose (Defaults are preselected):

     • Release Type (Stable/Beta/Alpha)

     • Program Version

     • OS Version

     • .NET Version

     • Download Location

   • Click Next.

4. Download the SDK

   • Click Start and wait for the files to download.

   • Click Next once the download is complete.

   • Click Finish.

Your SDK files are now downloaded to the specified location. Reference the following DLLs in your project: PaymentEngine, xCore, xCore.Forms, NLog, and Newtonsoft.Json.

(For SDK files with checksum click here)

Initiate Transaction

Initiating a transaction requires the selection of either the "in-scope" method (Process) or the "out-of-scope" method (ProcessOutOfScope). Before starting the transaction, ensure that all required and optional parameters have been properly set as outlined in the documentation.

Out-of-Scope (ProcessOutOfScope)

Use the out-of-scope transaction method when the user needs to provide their credit card information. In this case, the SDK will handle the process of collecting the sensitive credit card data from the user through a pop-up window or a credit card device, and then processing the transaction with the payment gateway.

In-Scope (Process)

Use the in-scope transaction method when there is no need for the SDK to interact with the user. This could be when you have already obtained the card number or when you want to run a void, for example. When using this method, you cannot set any parameters specific to a device.

Backup gateway host

You can set the transactions to use a backup host in case there is an issue with the gateway. See Transaction Specific>ActivateBackupGatewayURL. You can sign up for status updates at Cardknox Status

Transaction Workflow

Click here to view Transaction Workflows.