XML TransactionStatus Action

The purpose of the TransactionStatus request is to provide a way to determine the status of a request that was interrupted for some reason. For a transaction where the response was lost the transaction xid would be unknown to the client. To be able to use this request you have to have passed through a unique transaction identifier of your own using the VendorData elements which can be passed through with the original request. Ideally you would pass through a unique ID with every request, although this request will do the lookup based on multiple VendorData elements. If more than one record is matched based on the passed VendorData the first matching transaction will be used to generate the response. The transaction response will contain a warning message indicating that multiple transactions were matched in this case. Please note that this is NOT a search tool since it does not return multiple responses. This tool was also not written to automate the retrieval of past transaction history. The example below displays all fields that could potentially be used for this action.

Example

<?xml version="1.0"?> 
<GatewayInterface> 
    <APICredentials> 
        <Username>username</Username> 
        <PayloadSignature>EXAMPLESIGNATURE</PayloadSignature> 
        <TargetGateway>12345</TargetGateway> 
    </APICredentials> 
    <TranRetryTransaction> 
        <OperationXID>12345678</OperationXID>
<!-- Optional. Will use total and description from original transaction if not passsed.
     However, it one of these is passed, both must be. -->         
        <Description>ExampleItem</Description> 
        <Total>5.00</Total> 
<!-- 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> 
    </TranRetryTransaction> 
</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