developer:soap-1.1:methods:runcheckcredit

runCheckCredit

Run a check credit transaction.

Description

This method runs a check Credit transaction in order to refund all or part of a previous Sale, or issue an open credit to a customer's check or savings account. This method uses ACH to send money to a customer.

If this method is used to reverse or refund an electronic check transaction, please be aware that both the original transaction and the refund will appear as separate transactions on the customer's bank account statement. To reverse a sale without creating a new transaction, you must use the voidTransaction method. Please see the description of the voidTransaction method for more details on how to determine which of these methods is most appropriate.

See also runCheckSale, runTransaction, runQuickSale, voidTransaction, refundTransaction

Syntax

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
TransactionRequestObject Params Request transaction details from all fields of the transaction form, including reference number, transaction amount, customer ID, currency, authorization code, and any other information entered at the time of the transaction.

Return Value

TransactionResponse Returns a TransactionResponse object containing the results of the transaction and all relevant data.

Examples

.NET VB

Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject
 
        transaction.CheckData = New usaepay.CheckData
        transaction.CheckData.Account = "1112223333"
        transaction.CheckData.Routing = "123456789"
        transaction.CheckData.DriversLicense = "D5555555"
        transaction.CheckData.DriversLicenseState = "CA"
 
        transaction.Details = New usaepay.TransactionDetail
        transaction.Details.Amount = "1.00"
        transaction.Details.AmountSpecified = True
        transaction.Details.Invoice = "55555"
        transaction.Details.Description = "Test Check Sale"
 
        transaction.AccountHolder = "Test Guy"
 
        Dim response As usaepay.TransactionResponse
 
        response = client.runCheckCredit(token, transaction)
 
        If response.ResultCode = "A" Then
            MsgBox("Transaction Approved, Reference Number: " & response.RefNum)
        ElseIf response.ResultCode = "D" Then
            MsgBox("Transaction Declined, Reason: " & response.Error)
        Else
            MsgBox("Transaction Error, Reason: " & response.Error)
        End If

.NET C#

usaepay.TransactionRequestObject tran = new usaepay.TransactionRequestObject();
 
            tran.Details = new usaepay.TransactionDetail();
            tran.Details.Amount = 1.00;
            tran.Details.AmountSpecified = true;
            tran.Details.Invoice = "1234";
            tran.Details.Description = "Sample Check Credit";
 
            tran.CheckData = new usaepay.CheckData();
            tran.CheckData.Account = "1112223333";
            tran.CheckData.Routing = "123456789";
            tran.CheckData.DriversLicense = "D5555555";
            tran.CheckData.DriversLicenseState = "CA";
 
            tran.AccountHolder = "Test Guy";
 
            usaepay.TransactionResponse response = new usaepay.TransactionResponse();
 
            try
            {
                response = client.runCheckCredit(token, tran);
 
                if (response.ResultCode == "A")
                {
                    MessageBox.Show(string.Concat("Transaction Approved, RefNum: ",
                    response.RefNum));
                }
                else
                {
                    MessageBox.Show(string.Concat("Transaction Failed: ",
                    response.Error));
                }
            }
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
 
            }

Change History

Version Change
1.0 Method added in soap v1.0
developer/soap-1.1/methods/runcheckcredit.txt · Last modified: 2010/10/21 11:28 by irina

Page Tools