New API Call -- getSettledBatchList

Michelle — Thu, 28 Oct 2010 18:34:45 GMT

Hi everyone,

The next call of our new reporting API is available now! :smileyhappy:

We announced a new call a couple of weeks ago for getTransactionDetails. Now you can retrieve your settled batches using the new getSettledBatchList call. This API is available now in XML and SOAP.

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.

But for your convenience, here are the XML examples for the call and response:
-----------------------------------------------------------------------------------------------------------------------
The following is the XML sent to retrieve detailed information about a batch.
-----------------------------------------------------------------------------------------------------------------------

<?xml version="1.0" encoding="utf-8"?>
<getSettledBatchListRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
      <merchantAuthentication>
            <name> YOUR_USER_LOGIN</name>
            <transactionKey> YOUR_TRANSACTION_KEY</transactionKey>
      </merchantAuthentication>
      <includeStatistics>true</includeStatistics>
      <firstSettlementDate>2010-09-01T08:15:30</firstSettlementDate>
      <lastSettlementDate>2010-09-30T08:15:30</lastSettlementDate>
</getSettledBatchListRequest>

------------------------------------------------------------------------------------------------------------------------
The following is the XML response to a successful call to getSettledBatchList.
------------------------------------------------------------------------------------------------------------------------

<?xml version="1.0" encoding="utf-8"?>
<getSettledBatchListResponse 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>
      <batchList>
            <batch>
                  <batchId>17</batchId>
                  <settlementTimeUTC>2010-09-02T17:05:46Z</settlementTimeUTC>
                  <settlementTimeLocal>2010-09-02T10:05:46</settlementTimeLocal>
                  <settlementState>settledSuccessfully</settlementState>
                  <paymentMethod>creditCard</paymentMethod>
                  <statistics>
                        <statistic>
                              <accountType>DinersClub</accountType>
                              <chargeAmount>1789.52</chargeAmount>
                              <chargeCount>8</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Discover</accountType>
                              <chargeAmount>7186.20</chargeAmount>
                              <chargeCount>12</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>MasterCard</accountType>
                              <chargeAmount>8231.06</chargeAmount>
                              <chargeCount>12</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Visa</accountType>
                              <chargeAmount>2360.28</chargeAmount>
                              <chargeCount>8</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                  </statistics>
            </batch>
            <batch>
                  <batchId>18</batchId>
                  <settlementTimeUTC>2010-09-02T17:08:06Z</settlementTimeUTC>
                  <settlementTimeLocal>2010-09-02T10:08:06</settlementTimeLocal>
                  <settlementState>settledSuccessfully</settlementState>
                  <paymentMethod>creditCard</paymentMethod>
                  <statistics>
                        <statistic>
                              <accountType>DinersClub</accountType>
                              <chargeAmount>447.38</chargeAmount>
                              <chargeCount>2</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Discover</accountType>
                              <chargeAmount>1796.55</chargeAmount>
                              <chargeCount>3</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>MasterCard</accountType>
                              <chargeAmount>2057.74</chargeAmount>
                              <chargeCount>3</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Visa</accountType>
                              <chargeAmount>590.07</chargeAmount>
                              <chargeCount>2</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                  </statistics>
            </batch>
            <batch>
                  <batchId>19</batchId>
                  <settlementTimeUTC>2010-09-02T17:08:54Z</settlementTimeUTC>
                  <settlementTimeLocal>2010-09-02T10:08:54</settlementTimeLocal>
                  <settlementState>settledSuccessfully</settlementState>
                  <paymentMethod>creditCard</paymentMethod>
                  <statistics>
                        <statistic>
                              <accountType>DinersClub</accountType>
                              <chargeAmount>447.38</chargeAmount>
                              <chargeCount>2</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Discover</accountType>
                              <chargeAmount>1796.55</chargeAmount>
                              <chargeCount>3</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>MasterCard</accountType>
                              <chargeAmount>2057.68</chargeAmount>
                              <chargeCount>3</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Visa</accountType>
                              <chargeAmount>590.07</chargeAmount>
                              <chargeCount>2</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                  </statistics>
            </batch>
            <batch>
                  <batchId>20</batchId>
                  <settlementTimeUTC>2010-09-21T16:00:00Z</settlementTimeUTC>
                  <settlementTimeLocal>2010-09-21T09:00:00</settlementTimeLocal>
                  <settlementState>settledSuccessfully</settlementState>
                  <paymentMethod>creditCard</paymentMethod>
                  <statistics>
                        <statistic>
                              <accountType>DinersClub</accountType>
                              <chargeAmount>447.38</chargeAmount>
                              <chargeCount>2</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Discover</accountType>
                              <chargeAmount>1796.55</chargeAmount>
                              <chargeCount>3</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>MasterCard</accountType>
                              <chargeAmount>2058.96</chargeAmount>
                              <chargeCount>4</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Visa</accountType>
                              <chargeAmount>592.37</chargeAmount>
                              <chargeCount>4</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                  </statistics>
            </batch>
            <batch>
                  <batchId>21</batchId>
                  <settlementTimeUTC>2010-09-28T17:52:57Z</settlementTimeUTC>
                  <settlementTimeLocal>2010-09-28T10:52:57</settlementTimeLocal>
                  <settlementState>settledSuccessfully</settlementState>
                  <paymentMethod>creditCard</paymentMethod>
                  <statistics>
                        <statistic>
                              <accountType>MasterCard</accountType>
                              <chargeAmount>0.00</chargeAmount>
                              <chargeCount>0</chargeCount>
                              <refundAmount>839.95</refundAmount>
                              <refundCount>1</refundCount>
                              <voidCount>0</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                        <statistic>
                              <accountType>Visa</accountType>
                              <chargeAmount>0.00</chargeAmount>
                              <chargeCount>0</chargeCount>
                              <refundAmount>0.00</refundAmount>
                              <refundCount>0</refundCount>
                              <voidCount>1</voidCount>
                              <declineCount>0</declineCount>
                              <errorCount>0</errorCount>
                        </statistic>
                  </statistics>
            </batch>
      </batchList>
</getSettledBatchListResponse>

Remember, we've got one more call coming, so stay tuned!

Thanks,

Michelle
Developer Community Manager

topic New API Call -- getSettledBatchList in News and Announcements

New API Call -- getSettledBatchList