Developer's Guide
Table Of Contents
- Gateway Reporting Developer Guide
- Preface
- Reporting Overview
- Using the Reporting API
- Response Codes and Status Codes
- Reporting XML Schema
- Reporting Samples
- Running a Daily Activity Report
- Running a Transaction Summary Report
- Getting Results by Report ID
- Getting Metadata
- Getting Data
- Creating a Report Template
- Updating a Report Template
- Getting a Report Template
- Deleting a Report Template
- Creating a Schedule
- Getting a Schedule
- Updating a Schedule
- Deleting a Schedule
- Running a Transaction ID Search
- Running a Profile - Next Payment Date Report
- Running a Profile - Profile Modified Date Report
- Report Parameters
- Reports in This Appendix
- ACH Activity Summary Report
- ACH Batch ID Report
- ACH Detail Return Activity Report
- ACH Notification of Change Report
- ACH Return Activity Report
- ACH Settlement Report
- ACH Transaction Report
- Auto Credit Report
- Auto Delayed Capture Report
- Auto Resettle Report
- Auto Void Report
- Batch ID Report
- Custom Report
- Daily Activity Report
- Filter Scorecard Report
- Fraud Protection Report
- Payflow Link Orders Report
- PayPal Settlement Summary Report
- Profile Next Payment Report
- Profile Modified Date Report
- Recurring Billing Report
- Recurring Profile Failed Report
- Recurring Profile Report
- Settlement Report
- Shipping and Billing Report
- Transaction Summary Report
- Search Parameters
- Transaction ID Search
- Batch ID Search
- AccountNumberSearch
- CommentSearch
- AccountNumberRefSearch
- PurchaseOrderSearch
- RecurringBillingProfileIDSearch
- RecurringBillingProfileNameSearch
- RecurringBillingAccountNumberSearch
- RecurringBillingCommentSearch
- RecurringBillingAmountSearch
- FraudTransactionSearch
- OrderIDSearch
- PayPalTransactionIDSearch
- PayPalEmailSearch
- PayPalNameSearch
- Index
Report Parameters
Batch ID Report
C
74 Gateway Reporting Developer Guide
Batch ID Report
TABLE C.23 Batch ID Report input parameters
Name Description Type Required? Allowed values
Default
value
Auto-
computed
by
scheduler?
start_date Start date to run
report for
datetime
YYYY-MM-DD
HH:MI:SS
YN/AY
end_date End date to run
report for
datetime
YYYY-MM-DD
HH:MI:SS
YN/AY
processor Processor to
report on
string Y PayPal N/A N
timezone Timezone used to
interpret times
string N GMT
GMT+/-XX:XX
GMT N
group_by_
tender
Should group
results by tender?
string N true
false
false N
T
ABLE C.24 Batch ID Report output parameters
Column name Type Comment
Batch ID number Only if group_by_tender is
set to true
Settled Date date
Total Sales/Delayed Captures/Voice
Authorizations (Amount)
currency
Total Sales/Delayed Captures/Voice
Authorizations (Count)
number
Total Credits (Amount) currency
Total Credits (Count) number
Total Amount currency
Total Count number
tender_type string Only if group-by-tender is
set to true