XML CreditTransaction Action

This action will generate a credit/refund transaction for a transaction that was not originally processed through the gateway. This works for both credit cards and EFTs. The example below displays all fields that could potentially be used for this action - including the optional fields which are specified.

Optional Fields

CustId
Can be used for unique or custom identifiers generated by your system.
ShippingAddress
 
CardAccount elements
Use only for credit card transactions. Do not pass if passing CheckAccount elements.
CheckAccount elements
Use only for check/eft transactions. Do not pass if passing CardAccount elements.
RecurringData elements
Use only when initiating a transaction to be set for recurring billings.
TransactionControl elements
 

VendorData elements
 

Example

<?xml version="1.0"?>
 <GatewayInterface> 
   <APICredentials>
     <Username>username</Username>
     <PayloadSignature>EXAMPLESIGNATURE</PayloadSignature>
     <TargetGateway>12345</TargetGateway>
   </APICredentials>
   <CreditTransaction>
     <Total>5.00</Total>
       <CustomerData>
        <Email>demo@demo.com</Email>
        <!-- Optional -->
        <CustId>ABC12345</CustId>   
         <BillingAddress>
          <Address1>test</Address1>
          <FirstName>John</FirstName>
          <LastName>Smith</LastName>
          <City>Bountiful</City>
          <State>UT</State>
          <Zip>84032</Zip>
          <Country>USA</Country>
          <Phone>801-555-1212</Phone>
         </BillingAddress>
         <!-- Optional -->               
         <ShippingAddress>
          <Address1>test</Address1>            
          <FirstName>John</FirstName>
          <LastName>Smith</LastName>
          <City>Bountiful</City>
          <State>UT</State>
          <Zip>84032</Zip>
          <Country>USA</Country>
         </ShippingAddress>
       </CustomerData>
        <AccountInfo>
         <!-- For Credit card transaction. -->
          <CardAccount>
           <AccountNumber>5454545454545454</AccountNumber>
           <ExpirationMonth>01</ExpirationMonth>
           <ExpirationYear>2000</ExpirationYear>
          </CardAccount>
         <!-- For EFT transactions. -->                    
          <CheckAccount>
           <AccountNumber>123456</AccountNumber>
           <ABA>124000054</ABA>
           <!-- Account Source Identifier if required by NACHA processor -->    
           <AccountSource>checking</AccountSource>
          </CheckAccount>            
        </AccountInfo>        
        <!-- All TransactionControl elements are optional including TransactionControl -->        
        <TransactionControl>
         <SendCustomerEmail>TRUE</SendCustomerEmail> <!-- TRUE/FALSE -->
         <SendMerchantEmail>TRUE</SendMerchantEmail> <!-- TRUE/FALSE -->           
         <TestMode>TRUE</TestMode> <!-- TRUE/FALSE -->
         <EmailText> <!-- Up to 10 EmailTextItem elements allowed -->
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
          <EmailTextItem>test1</EmailTextItem>
         </EmailText>
        </TransactionControl>
<!-- Optional.  This information will be saved on our servers and is
available in the XML transaction report.  This is useful if you want
to save your own transaction meta-data with a transaction.    -->        
        <VendorData>
         <Element>
          <Name>repId</Name>
          <Value>1234567</Value>
         </Element>
        </VendorData>
   </CreditTransaction>
 </GatewayInterface>

For additional information, please view the XML API Connection documentation HERE.

 

 

Sidebar Heading

Sidebar Subheading

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin vitae lacus et massa viverra dictum.

Sidebar Subheading

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin vitae lacus et massa viverra dictum