Reporting API

[Frank Gibbs]

We are about ready to release our Reporint API

Input
   StartDate
   EndDate

XML Sample Output
<collection>
<ReportItem>
<timestamp>06/01/2007 05:06:41</timestamp>
<amount>12.00</amount>
<ttid>70619</ttid>
<type>SETTLE</type>
<card>UNKNOWN</card>
<account></account>
<expdate></expdate>
<authnum></authnum>
<batchnum>116</batchnum>
<cardholdername></cardholdername>
<avs></avs>
<cv></cv>
<ptrannum>-1</ptrannum>
<clerkid></clerkid>
<stationid></stationid>
<comments> T:1|12.00  A:1|12.00  R:0|0.00</comments>
</ReportItem>
<ReportItem>
<timestamp>06/01/2007 01:36:41</timestamp>
<amount>12.00</amount>
<ttid>70620</ttid>
<type>SALE</type>
<card>VISA</card>
<account>XXXXXXXXX8881</account>
<expdate>1207</expdate>
<authnum>TAS216</authnum>
<batchnum>117</batchnum>
<cardholdername>Test Card Holder</cardholdername>
<avs>GOOD</avs>
<cv>GOOD</cv>
<ptrannum>1</ptrannum>
<clerkid>Test Clerk</clerkid>
<stationid>TestStation</stationid>
<comments></comments>
</ReportItem>
</collection>

[Frank Gibbs]

it's important to note that there is not settlement time for each tranaction. A settlement is returned as a transaction with a type of SETTLE.

Let me know if you need more clarification on this. We will be ready to release this API this week.

[jeevan]

Hi Frank,

Thanks for providing the specs for Reporting API. We are having few assumptions & clarifications regarding the parameters in the API as follows:

1. We assume that the parameter "ttid" refers to transactionid in the XML response to the payment request sent to iDeposit.
2. We assume that the parameter "authnum" refers to authorization number in the XML response to the payment request sent to iDeposit.
3. We would like to know what is the return value & purpose of parameters "batchnum" & "ptrannum".

Regards
Jeevan

[jeevan]

Hi Frank,

Thanks for providing the specs for Reporting API. We are having few assumptions & clarifications regarding the parameters in the API as follows:

1. We assume that the parameter "ttid" refers to transactionid in the XML response to the payment request sent to iDeposit.
2. We assume that the parameter "authnum" refers to authorization number in the XML response to the payment request sent to iDeposit.
3. We would like to know what is the return value & purpose of parameters "batchnum" & "ptrannum".
4. Also could you let us know to which URL we need to poll to get the report data. Is it the same URL (https://www.ideposit.net/servlet/pg) we are using for normal transactions or any other URL?.
5. Also let us know whether we need to pass the username & password parameters to this URL?

Regards
Jeevan

[Frank Gibbs]

When release the API it will be released with full documentation describing all input and output.

1. We assume that the parameter "ttid" refers to transactionid in the XML response to the payment request sent to iDeposit.
      Yes

2. We assume that the parameter "authnum" refers to authorization number in the XML response to the payment request sent to iDeposit.
     Yes

3. We would like to know what is the return value & purpose of parameters "batchnum" & "ptrannum".
     batchnum - a unique value assigned to all transaction between settlements. It's like a group identifier.
     ptrannum - Tracking_Number Usually an invoice number

4. Also could you let us know to which URL we need to poll to get the report data. Is it the same URL (https://www.ideposit.net/servlet/pg) we are using for normal transactions or any other URL?.
     URL will be published later this week.     
5. Also let us know whether we need to pass the username & password parameters to this URL?
     Yes you will

[Frank Gibbs]

Below are the two links to you need to begin using Reporting API

http://www.ideposit.net/jsp/report_api/report_api.jsp
http://www.ideposit.net/jsp/report_api/test_form.jsp