.NET Library v 1.7

To use this class in your Visual Studio project, follow these steps:

• Download and extract the zip file above
• Open your project in Visual Studio
• In the Solution Explorer, right click on your application and choose “Add Reference…

• Click on the “Browse” tab and select the USAePayAPI.dll file and click “Ok”

• To initialize the USAePay client in your code, instantiate USAePayAPI.USAePay:

Dim usaepay As USAePayAPI.USAePay = New USAePayAPI.USAePay

The sample source key and pin used in each example has been provided for use in your testing. They have been configured to run on our test platform that allows for full testing of the transaction process. By using the samples provided, you can test run all commands, including closing/settling the batch. Any valid card number should return an approval, but you can also use the special test card numbers to receive specific responses.

The most common transaction is a Sale. During a Sale, the customer's card will be authorized for the specified amount and placed in the batch for settlement. Once the batch has been settled, the funds will be transfered to the merchant's account. Please note: Unless the merchant's account has been configured to auto close, he or she will need to log into usaepay.com in order to close each batch.

        Dim usaepay As USAePayAPI.USAePay = New USAePayAPI.USAePay
        Dim message As String
        usaepay.SourceKey = "dgb8otyulg26vm2hYiF8b2q6P7091681"
        usaepay.Pin = "ABA123"
        usaepay.Amount = 2.23
        usaepay.Description = "A test transaction"
        usaepay.CardHolder = "Joe Schmoe"
        usaepay.CardNumber = "4444555566667779"
        usaepay.CardExp = "0909"
        usaepay.IgnoreDupe = True
 
        'For Sandbox accounts set to true
        usaepay.UseSandbox = "false"
 
 
        Try
            usaepay.Sale()
	        If usaepay.ResultCode = "A" Then
	            message = "Transaction approved" & vbLf _
	                & "Auth Code: " & usaepay.AuthCode & vbLf _
	                & "Ref Num: " & usaepay.ResultRefNum & vbLf _
	                & "AVS: " & usaepay.AvsResult & vbLf _
	                & "CVV: " & usaepay.Cvv2Result
	        ElseIf usaepay.ResultCode = "D" Then
	            message = "Transaction Declined" & vbLf _
	                & "Ref Num: " & usaepay.ResultRefNum
	        Else
	            message = "Transaction Error" & vbLf _
	                & "Ref Num: " & usaepay.ResultRefNum & vbLf _
	                & "Error: " & usaepay.ErrorMesg & vbLf _
	                & "Error Code: " & usaepay.ErrorCode & vbLf
	        End If
	        MsgBox(message)
        Catch ex As Exception
            MsgBox("Caught Exception: " & ex.Message)
        End Try

	private void RunSale()
	{
		USAePayAPI.USAePay usaepay = new USAePayAPI.USAePay();
		usaepay.SourceKey = "dgb8otyulg26vm2hYiF8b2q6P7091681";
        usaepay.Pin = "ABA123";
        usaepay.Amount = 2.23;
        usaepay.Description = "A test transaction";
        usaepay.CardHolder = "Joe Schmoe";
        usaepay.CardNumber = "4444555566667779";
        usaepay.CardExp = "0909";
 
        //For Sandbox accounts set to true
        usaepay.UseSandbox = "false"
 
 
		try 
		{
			usaepay.Sale();
			if(usaepay.ResultCode == "A")
			{
				lblStatus.Text = "Transaction approved\n" +
					"Auth Code: " + usaepay.AuthCode + "\n" +
					"Ref Num: " + usaepay.ResultRefNum + "\n" +
					"AVS: " + usaepay.AvsResult + "\n" +
					"CVV: " + usaepay.Cvv2Result;
			} 
			else if(usaepay.ResultCode == "D")
			{
				lblStatus.Text = "Transaction Declined\n" +
					"Ref Num: " + usaepay.ResultRefNum;
			} else {
				lblStatus.Text="Transaction Error\n" +
					"Ref Num: " + usaepay.ResultRefNum + "\n" +
					"Error: " + usaepay.ErrorMesg + "\n" +
					"Error Code: " + usaepay.ErrorCode;
			}
 
 
		}
		catch(Exception x) 
		{
			lblStatus.Text="ERROR: " + x.Message;
		}
	}

This example shows you how to query the status of a specific batch to determine the total number of transactions and total monetary amount of the batch.

        Dim usaepay As USAePayAPI.USAePay = New USAePayAPI.USAePay
 
        usaepay.SourceKey = "dgb8otyulg26vm2hYiF8b2q6P7091681"
 
        ' Batch Closure requires a PIN
        usaepay.Pin = "ABA123"
 
        ' For Sandbox accounts set to true
        usaepay.UseSandbox = "false"
 
        Dim batch As USAePayAPI.BatchStatus
 
        ' A batch number of "0" retreives info on currently open batch
        Try
            batch = usaepay.BatchStatus("0")
            MsgBox("Batch Status: " & vbLf _
                    & " Batch ID: " & batch.BatchID & vbLf _
                    & " Status: " & batch.Status & vbLf _
                    & " Transactions: " & batch.TransactionCount & vbLf _
                    & " Total: " & batch.Total & vbLf)
 
        Catch ex As Exception
            MsgBox("Unable to retreive batch status: " & ex.Message)
        End Try

	private void GetBatchData()
	{
		USAePayAPI.USAePay usaepay = new USAePayAPI.USAePay();
		USAePayAPI.BatchStatus batch = new USAePayAPI.BatchStatus();
 
		//Init object with our source key and pin from usaepay.com
		usaepay.SourceKey = "dgb8otyulg26vm2hYiF8b2q6P7091681";
		usaepay.Pin = "ABA123";
 
                //For Sandbox accounts set to true
                usaepay.UseSandbox = "false";
 
		try 
		{
			batch = usaepay.BatchSummary("0");
			lblStatus.Text = "Batch Status: \n" +
                " Batch ID: " + batch.BatchID + "\n" +
                " Status: " + batch.Status + "\n" +
                " Transactions: " + batch.TransactionCount + "\n" +
                " Total: " + batch.Total;
		}
		catch(Exception x) 
		{
			lblStatus.Text="Unable to retreive batch status: " + x.Message;
		}
	}

The BatchStatus object is returned by batch related functions such as BatchSummary() and CloseBatch(). Below are the properties available in the BatchStatus Object.

The default timeout property (Public Timeout As Integer = 30) is set to 30 seconds. If you are experiencing transactions taking longer than 30 seconds to process changing this property to a higher value like 60 (seconds) will resolve the issue.