Reply
Highlighted
All Star
Posts: 1,072
Registered: ‎08-17-2009

New API Call -- getTransactionList

Hi everyone,

The third call of our new reporting API is available now! (And there was much rejoicing....yay!) :smileyhappy:

This third call flushes out the already released getTransactionDetails and getSettledBatchList calls. Now you can retrieve the transactions in your settled batches using getTransactionList. This API is available now in XML and SOAP.

The updated guides for the Transaction Details API aren't live to the site yet, but I don't want to make you wait, so here's a sneak peak into the XML for the call and response. I'll reply to this message with the links of the guides once they're live.

-----------------------------------------------------------------------------------------------------------------------
The following is the XML sent to retrieve a list of transactions in a batch
-----------------------------------------------------------------------------------------------------------------------

 

 

<?xml version="1.0" encoding="utf-8"?>
<getTransactionListRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
     <merchantAuthentication>
             <name>YourUserLogin</name>
             <transactionKey>YourTranKey</transactionKey>
     </merchantAuthentication>
     <batchId>21</batchId>
</getTransactionListRequest>

  ------------------------------------------------------------------------------------------------------------------------
The following is the XML response to a successful call to getTransactionListRequest
------------------------------------------------------------------------------------------------------------------------

 

 

<?xml version="1.0" encoding="utf-8"?>
<getTransactionListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
     <messages>
           <resultCode>Ok</resultCode>
           <message>
                 <code>I00001</code>
                 <text>Successful.</text>
           </message>
     </messages>
     <transactions>
           <transaction>
                  <transId>234</transId>
                  <submitTimeUTC>2010-09-28T17:51:31Z</submitTimeUTC>
                  <submitTimeLocal>2010-09-28T10:51:31</submitTimeLocal>
                  <transactionStatus>refundSettledSuccessfully</transactionStatus>
                  <invoiceNumber>546572893</invoiceNumber>
                  <firstName>John</firstName>
                  <lastName>Doe</lastName>
                  <accountType>MasterCard</accountType>
                  <accountNumber>XXXX4796</accountNumber>
                  <settleAmount>839.95</settleAmount>
           </transaction>
           <transaction>
                  <transId>233</transId>
                  <submitTimeUTC>2010-09-22T20:34:35Z</submitTimeUTC>
                  <submitTimeLocal>2010-09-22T13:34:35</submitTimeLocal>
                  <transactionStatus>voided</transactionStatus>
                  <firstName>Jane</firstName>
                  <lastName>Doe</lastName>
                  <accountType>Visa</accountType>
                  <accountNumber>XXXX1111</accountNumber>
                  <settleAmount>0.00</settleAmount>
          </transaction>
      </transactions>
</getTransactionListResponse>

 

 

And that completes the reporting API for now. Have at it!

 

Thanks,

Michelle
Developer Community Manager

 

 

 

Highlighted
All Star
Posts: 1,072
Registered: ‎08-17-2009

Re: New API Call -- getTransactionList

There is also a setting in the Merchant Interface that must be enabled in order to use the reporting API.

 

To do this:

 

  1. Log into the Merchant Interface at https://account.authorize.net
  2. Click Account from the main toolbar
  3. Click Transaction Details API from the General Security Settings section
  4. Enter your Secret Answer to your Secret Question in the field provided
  5. Click Enable Transaction Details API

Once the feature is enabled, you may use the three calls of the reporting API. You can disable the feature at any time by following the steps above and clicking Disable Transaction Details API.

 

Thanks,

 

Michelle

Developer Community Manager

Highlighted
All Star
Posts: 1,072
Registered: ‎08-17-2009

Re: New API Call -- getTransactionList

By the way, the guides are now live. You can find the XML guide at http://www.authorize.net/support/ReportingGuide_XML.pdf and the SOAP guide at http://www.authorize.net/support/ReportingGuide_SOAP.pdf.

 

Michelle

Developer Community Manager