2012
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
Contents
4 Gateway Reporting Developer Guide
Chapter 3 Response Codes and Status Codes . . . . . . . . . . . . .19
Response Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Appendix A Reporting XML Schema . . . . . . . . . . . . . . . . . . .21
Appendix B Reporting Samples . . . . . . . . . . . . . . . . . . . . .29
Running a Daily Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Running a Daily Activity Report Request . . . . . . . . . . . . . . . . . . . . . . . . 29
Running a Daily Activity Report Response . . . . . . . . . . . . . . . . . . . . . . . 30
Running a Transaction Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Running a Transaction Summary Report Request . . . . . . . . . . . . . . . . . . . 31
Running a Transaction Summary Report Response . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID Request. . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID Response . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Format Returned. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Getting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Getting Data Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Getting Data Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Data Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Creating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Creating a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Creating a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 47
Updating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Updating a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Updating a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 48
Getting a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Getting a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Getting a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Deleting a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Deleting a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 50
Creating a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Creating a Schedule Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51