CarrotCat.PaymentGatewayDotnet 1.0.2-beta

PaymentGatewayDotnet

v0.1.0-beta

Please review LICENSE.md before using this library.

What is PaymentGatewayDotnet?

PaymentGatewayDotnet is a library that provides comprehensive and convenient way to assemble and make transactions with *.transactiongateway.com type of gateways. The advantage of this library is that it brakes down gateway requests into logical and digestible chunks making it easier to build the requests. This library has both static and service implementations of gateway client and can be used both as stand-alone and via dependency injection.

Compatibility?

PaymentGatewayDotnet is .NET Standard 2.0 library. You can check .NET Standard 2.0 compatibility with your version of .NET on this page

How do I get Started?

First, of course, you need to download PaymentGatewayDotnet NuGet package and add dependency to your project.

Next steps depend on implementation that you will choose: static, or service.

Static

WARNING!!! If your app will be making a lot of gateway requests, using static implementation can lead to socket exhaustion problem that will either slow down, freeze, or crash your application.

I strongly advise against using this method.

To make the request simply pass your FinancialRequest, CustomerVaultRequest, InvoicingRequest, or RecurringPlanRequest object and Uri object containing gateway address to Gateway.PaymentApiPost() method and await the PaymentApiResponse:

PaymentApiResponse response = await Gateway.PaymentApiPost(new FinancialRequest("YourPrivateKey"), new Uri("YourGatewayUri"));

Service

The most proper way to use GatewayClient is utilize .NET's dependency injection framework. To do that you will need to register GatewayClient in your Startup.cs or Program.cs and pass your base address Uri (e.g.: "new Uri(https://abc.transactiongateway.com)") as an argument. (The exact implementation may wary based on your version of .NET)

builder.Services.AddTransient<IGatewyClient, GatewayClient>(new Uri(https://abc.transactiongateway.com));

Note: you can also setup GatewayClient as Singleton or Scoped service, depending on your app needs.

You can now inject Gateway Client to your controller or service:

class Foo{
    private readonly IGatewayClient _gatewayClient;

    public Foo(IGatewayClient gatewayClient)
    {
        _gatewayClient = gatewayClient;
    }

    //ToDo: Implement rest of the class methods
}

you can now use it in your class:

PaymentApiResponse response = await _gatewayClient.PaymentApiPost(new TransactionRequest("YourPrivateKey", FinancialRequestType.Sale));

How do I create request object?

In this library Gateway's Payment API request is separated into 4 separate requests TransactionRequest, CustomerVaultRequest, InvoicingRequest, and RecurringPlanRequest. To create a request you need to instantiate one of these objects, passing your Private Security Key into it, and then add your request parameters:

var request = new TransactionRequest("SecurityKey", TransactionRequestType.Sale)
        {
            PaymentCredentials = new PaymentCredentials()
            {
                CreditCard = new CreditCard()
                {
                    Number = "4111111111111111",
                    Expiration = "10/25",
                    Cvv = "999"
                }
            },
            Amount = new decimal(1.50),
            Billing = new Billing() { Address = new Address() { Address1 = "888", PostalZip = "77777" } },
        };

What about response?

Response comes in the form of PaymentApiResponse object with property names that correspond to those in your documentation.
PaymentApiResponse object also contains convenience fields to get text response values instead of original numeric codes:

public sealed class PaymentApiResponse
{
        public byte? RawResponse { get; }
        public string ResponseText { get; }
        public string AuthCode { get; }
        public string TransactionId { get; }
        public string RawAvsResponse { get; }
        public string RawCvvResponse { get; }
        public string OrderId { get; }
        public string Type { get; }
        public string ResponseCode { get; }
        public string EmvAuthResponseData { get; }
        public string ProcessorId { get; }
        public string CustomerVaultId { get; }
        public string KountScore { get; }
        
        public TransactionResponse TransactionResponse => TransactionResponseUtils.ParseByte(RawResponse);
        public string ResponseMessage => ResultCodes.GetResponseCodeString(ResponseCode);
        public string AvsResponse => ResultCodes.GetAvsResponseString(RawAvsResponse);
        public string CvvResponse => ResultCodes.GetCvvResponseString(RawCvvResponse);
}

Query API

To send Query API request pass instance of QueryApiRequest object to Gateway Client QueryApiPost() method

QueryApiResponse response = await _gatewayClient.QueryApiPost(new QueryApiRequest("YourPrivateKey"));

How do I set Query API search parameters

You can set your query parameters as properties of QueryApiRequest object. For example:

        var queryApiRequest = new QueryApiRequest(securityKey)
        {
            Conditions = new List<Condition> { Condition.PendingSettlement, Condition.Complete },
            TransactionType = PaymentType.CreditCard,
            ActionTypes = new List<TransactionType> { TransactionType.Sale, TransactionType.Auth },
            Sources = new List<Source> { Source.Api, Source.Recurring },
            TransactionIds = new List<string> { "TRAN001", "TRAN002" },
            SubscriptionIds = new List<string> { "SUBS001", "SUBS002" },
            InvoiceId = "INV001",
            PartialPaymentId = "PARTIAL001",
            OrderId = "ORDER001",
            FirstName = "John",
            LastName = "Doe",
            Address1 = "123 Main St",
            City = "New York",
            State = "NY",
            Zip = "10001",
            Phone = "555-123-4567",
            Fax = "555-987-6543",
            OrderDescription = "Test Order",
            DriversLicenseNumber = "DL123456",
            DriversLicenseDob = "19800101",
            DriversLicenseState = "NY",
            Email = "john.doe@example.com",
            CcNumber = "4111111111111111",
            MerchantDefinedFields = new List<MerchantDefinedField>
            {
                new ( 1, "Value1" ),
                new ( 2, "Value2" )
            },
            StartDate = new DateTime(2023, 7, 1, 0, 0, 0),
            EndDate = new DateTime(2023, 7, 31, 23, 59, 59),
            ReportType = ReportType.CustomerVault,
            MobileDeviceLicence = "D91AC56A-4242-3131-2323-2AE4AA6DB6EB,any_mobile",
            MobileDeviceNickname = "Jim's iPhone",
            CustomerVaultId = "CUST001",
            DateSearch = new List<DateType> { DateType.Created, DateType.Updated },
            ResultLimit = 10,
            PageNumber = 1,
            ResultOrder = ResultOrder.Reverse,
            InvoiceStatuses = new List<InvoiceStatus> { InvoiceStatus.Paid, InvoiceStatus.Closed }
        };

How do I query the receipt?

Since receipt query only takes one parameter - Transaction ID - there is a shortcut that you can use to get receipt Instantiate QueryApiRecieptRequest object passing Transaction Id as constructor parameter and then pass it as argument to Gateway Client QueryApiGetReceipt() method:

QueryApiResponse response = await _gatewayClient.QueryApiGetReceipt(new QueryApiRecieptRequest("Your Transaction ID"));

What about Query response?

Query response comes in the form of QueryApiResponse object that mirrors gateway documentation.

    public sealed class QueryApiResponse
    {
        public List<Transaction> Transactions { get; private set; }
        public CustomerVault CustomerVault { get; private set; }
        public List<RecurringSubscription> Subscriptions { get; private set; }
        public InvoiceReport InvoiceReport { get; private set; }
        public List<RecurringPlan> SubscriptionPlans { get; private set; }
        public string Receipt { get; private set; }
        public bool? TestModeEnabled { get; private set; }
    }

Contributors

Empyrean Merchant Services

ChatGPT - Helping me to save some time with especially tedious unit tests.

Version History

v1.0.0

• Added support for Payment API requests

v1.0.1

• Reworked project structure for better readability
• Added support for QueryApi

v1.0.2

• Added some missing parameters