RecurUpdate

This request allows you to modify the transaction information and recurring commands for a recurring transaction. This request does not support the activation of recurring billing on an existing non-recurring transaction. That must be done manually through the Control Panel.

The example below displays all fields that could potentially be used for this action – including the optional fields which are specified.

Optional Fields

RemReps

Recipe

CustomerData elements

AccountInfo elements

OrderItems elements

Total

Request Example

<?xml version="1.0"?>
 <GatewayInterface>
   <APICredentials>
     <Username>username</Username>
     <PayloadSignature>EXAMPLESIGNATURE</PayloadSignature>
     <TargetGateway>12345</TargetGateway>
   </APICredentials>
   <!-- Other than OperationXID, all of the child elements of RecurUpdate 
   are individually optional but you must pass -->            
   <!-- one of Recipe, RemReps, CustomerData, OrderItems or Total -->                
   <RecurUpdate>
    <OperationXID>12345678</OperationXID>
     <!-- Optional.-->        
     <RemReps>123</RemReps>
     <!-- Optional.-->        
     <Recipe>Recipe Name</Recipe>        
     <!-- Optional.  Will update customer info tied to recurring transaction if passed-->        
      <CustomerData>
       <Email>demo@demo.com</Email>
       <CustId>ABC123</CustId> <!-- Optional -->
        <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>
         <!-- Optional.  Will update customer info tied to recurring transaction if passed-->                
        <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>
         </CheckAccount>            
        </AccountInfo>     
      </CustomerData>   
         <!-- Only one of OrderItems or Total elements may be passed in but neither are required -->
          <OrderItems>
           <Item>
            <Description>item1</Description>
            <Cost>5.00</Cost>
            <Qty>1</Qty>
           </Item>
          </OrderItems>        
         <!-- To use the Total element the original transaction 
         can only have one item associated with it  -->        
         <Total>12.00</Total>        
     </RecurUpdate>
 </GatewayInterface>

Response Example

<?xml version="1.0" standalone="yes"?>
 <GatewayInterface>
  <RecurUpdateResponse>
   <Status>ok</Status>
   <ErrorCategory></ErrorCategory>
   <ErrorMessage></ErrorMessage>
   <TimeStamp>20060621154341</TimeStamp>
   <TestMode>FALSE</TestMode> <!-- TRUE/FALSE -->
    <RecurDetails>
     <RemReps>10</RemReps>
     <RecipeName>daily</RecipeName>
     <RecurTotal>1.00</RecurTotal>
    </RecurDetails>
  </RecurUpdateResponse>
 </GatewayInterface>

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