runCredit

Parent Previous Next

runCredit

Runs a credit transaction.

 

Description

This method runs a Credit transaction in order to refund all or part of a previous Sale, or issue an open credit to a customer's credit card.

Use the runCredit method to refund a customer's card once the initial Sale has been settled. If the batch that the Sale is in has not yet been settled, you may want to use the voidTransaction method instead, which will prevent the initial Sale from ever appearing on the customer's credit card statement.

(See the description of the voidTransaction method for more details.)

Using the runCredit method will cause both the initial charge and the credit to appear on the customer's credit card statement.

 

Syntax

TransactionResponse runCredit ( ueSecurityToken Token, TransactionRequestObject Params )

 

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

 

PHP

 

<?php

try {

 $Request=array(

   'AccountHolder' => 'Tester Jones',

   'Details' => array(

   'Description' => 'Example Transaction',

   'Amount' => '4.00',

   'Invoice' => '44539'

   ),

 'CreditCardData' => array(

   'CardNumber' => '4444555566667779',

   'CardExpiration' => '0909',

   'AvsStreet' => '1234 Main Street',

   'AvsZip' => '99281',

   'CardCode' => '999'

   )

 );

 $res=$client->runCredit($token, $Request);

 print_r($res);

}

catch (SoapFault $e) {

 echo $client->__getLastRequest();

 echo $client->__getLastResponse();

 die("QuickSale failed :" .$e->getMessage());

 }

?>

 

Java

 

try {

 TransactionRequestObject params = new TransactionRequestObject();

   // set card holder name

   params.setAccountHolder("Test Joe");

   // populate transaction details

   TransactionDetail details = new TransactionDetail();

     details.setAmount(22.34);

     details.setDescription("My Test Sale");

     details.setInvoice("119891");

   params.setDetails(details);

   // populate credit card data

   CreditCardData ccdata = new CreditCardData();

     ccdata.setCardNumber("4444555566667779");

     ccdata.setCardExpiration("0912");

     ccdata.setCardCode("999");

   params.setCreditCardData(ccdata);

 // Create request object

 RunSale request = new RunSale();

   request.setToken(token);

   request.setParams(params);

 // Create response object

 TransactionResponse response;

 // run credit

 response = client.runCredit(token, params);

 System.out.println("Result: " + response.getResult());

} catch (Exception e) {

   System.out.println("Soap Exception: " + e.getMessage());

}

VB

 

Dim client As eBizCharge.eBizChargeService = New eBizCharge.eBizChargeService

       Dim token As eBizCharge.ueSecurityToken

       token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234")

       Dim transaction As eBizCharge.TransactionRequestObject = New eBizCharge.TransactionRequestObject

       transaction.CreditCardData = New eBizCharge.CreditCardData

       transaction.CreditCardData.CardNumber = "4444555566667779"

       transaction.CreditCardData.CardExpiration = "1212"

       transaction.CreditCardData.CardCode = "999"

       transaction.Details = New eBizCharge.TransactionDetail

       transaction.Details.Amount = "1.00"

       transaction.Details.AmountSpecified = True

       transaction.Details.Invoice = "12345"

       transaction.Details.Description = "Sample Credit"

       Dim response As eBizCharge.TransactionResponse = New eBizCharge.TransactionResponse

       response = client.runCredit(token, transaction)

       If response.ResultCode = "A" Then

           MsgBox("Transaction Approved, Refnum: " & response.RefNum)

       Else

           MsgBox("Transaction Error, Reason: " & response.Error)

       End If

 

 

.NET C#

 

eBizCharge.TransactionRequestObject tran = new eBizCharge.TransactionRequestObject();

           tran.Details =  new eBizCharge.TransactionDetail();

           tran.Details.Amount = 1.00;

           tran.Details.AmountSpecified = true;

           tran.Details.Invoice = "1234";

           tran.Details.Description = "Sample Credit";

           tran.CreditCardData = new eBizCharge.CreditCardData();

           tran.CreditCardData.CardNumber = "4444555566667779";

           tran.CreditCardData.CardExpiration = "1212";

           eBizCharge.TransactionResponse response = new eBizCharge.TransactionResponse();

           try

           {

               response = client.runCredit(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);

           }

 

XML

 

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ns1="urn:eBizCharge" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Body>

<ns1:runCredit>

<Token xsi:type="ns1:ueSecurityToken">

<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>

<PinHash xsi:type="ns1:ueHash">

<HashValue xsi:type="xsd:string">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>

<Seed xsi:type="xsd:string">12678150211876663375</Seed>

<Type xsi:type="xsd:string">sha1</Type>

</PinHash>

<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>

</Token>

<Params xsi:type="ns1:TransactionRequestObject">

<AccountHolder xsi:type="xsd:string">Tester Jones</AccountHolder>

<CreditCardData xsi:type="ns1:CreditCardData">

<AvsStreet xsi:type="xsd:string">1234 Main Street</AvsStreet>

<AvsZip xsi:type="xsd:string">99281</AvsZip>

<CardCode xsi:type="xsd:string">999</CardCode>

<CardExpiration xsi:type="xsd:string">1212</CardExpiration>

<CardNumber xsi:type="xsd:string">4444555566667779</CardNumber>

</CreditCardData>

<Details xsi:type="ns1:TransactionDetail">

<Amount xsi:type="xsd:double">4</Amount>

<Description xsi:type="xsd:string">Example Transaction</Description>

<Invoice xsi:type="xsd:string">44539</Invoice>

</Details>

</Params>

</ns1:runCredit>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>