# Report Parameters (/api/nvp-soap/payflow/reports/report-parameters)
The input and output parameters of the following reports are included here.
* [ACH Activity Summary Report](#ach-activity-summary-report)
* [ACH Batch ID Report](#ach-batch-id-report)
* [ACH Detail Return Activity Report](#ach-detail-return-activity-report)
* [ACH Notification of Change Report](#ach-notification-of-change-report)
* [ACH Return Activity Report](#ach-return-activity-report)
* [ACH Settlement Report](#ach-settlement-report)
* [ACH Transaction Report](#ach-transaction-report)
* [Auto Credit Report](#auto-credit-report)
* [Auto Delayed Capture Report](#auto-delayed-capture-report)
* [Auto Resettle Report](#auto-resettle-report)
* [Auto Void Report](#auto-void-report)
* [Batch ID Report](#batch-id-report)
* [Custom Report](#custom-report)
* [Daily Activity Report](#daily-activity-report)
* [Filter Scorecard Report](#filter-scorecard-report)
* [Fraud Protection Report](#fraud-protection-report)
* [Payflow Link Orders Report](#payflow-link-orders-report)
* [PayPal Settlement Summary Report](#paypal-settlement-summary-report)
* [Profile Next Payment Report](#recurring-billing-profile-by-next-payment-report)
* [Profile Modified Date Report](#recurring-billing-profile-by-modified-date-report)
* [Recurring Billing Report](#recurring-billing-report)
* [Recurring Profile Failed Report](#recurring-profile-failed-report)
* [Recurring Profile Report](#recurring-profile-report)
* [Settlement Report](#settlement-report)
* [Shipping and Billing Report](#shipping-and-billing-report)
* [Transaction Summary Report](#transaction-summary-report)
## ACH Activity Summary Report [#ach-activity-summary-report]
Report Name: `ACHActivitySummaryReport`
### Input parameters [#input-parameters]
| Name | Description | Type | Required? | Allowed value | Default value | Auto computed by scheduler? |
| ---------------------------- | ---------------------------------------- | ---------------------------- | --------- | ------------------------------------------------------------------------------- | ----------------------------------------- | --------------------------- |
| `report_date` | Date for which report needs to be pulled | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `sort_by` | Column to sort data by | string | N | Transaction ID, Transaction Time, Transaction Type, Tender Type, Amount, Result | Transaction Time | |
| `sort_option` | Sort by ascending or descending order | string | N | Descending | No Order | |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX: | GMT − 7 | |
| `include_pending_settlement` | | string | N | true, false | TRUE | |
| `include_settled` | | string | N | true, false | TRUE | |
| `include_failed` | | string | N | true, false | TRUE | |
### Output parameters [#output-parameters]
| Column name | Type | Comment |
| ----------------- | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | |
| `Account ABA` | string | |
| `Amount` | currency | |
| `Status` | string | |
| `Description` | string | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Result Code Msg` | string | |
| `Customer Ref` | string | |
| `Currency Symbol` | string | |
## ACH Batch ID Report [#ach-batch-id-report]
### Input parameters [#input-parameters-1]
| 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 | Y | | | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | | |
| `timezone` | Timezone used to interpret times | string | N | | GMT-7 | |
| `host_type` | | number | Y | 68 | | |
| `batch_id` | | number | N | | | |
| `BatchByCard` | | string | N | true, false | FALSE | |
| `batch_type` | | string | N | Consumer Batch, Merchant Batch | Merchant Batch | |
### Output parameters [#output-parameters-1]
| Column name | Type | Comment |
| ------------------------------------------------------------ | -------- | ---------------------------------------- |
| `Host Type` | number | |
| `Batch ID` | number | |
| `Tender Type` | string | If BatchByCard is given as TRUE in input |
| `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` | string | |
| `Currency Symbol` | string | |
| `Begin Time` | date | |
| `End Time` | date | |
## ACH Detail Return Activity Report [#ach-detail-return-activity-report]
Report Name: `ACHDetailReturnActivityReport`
### Input parameters [#input-parameters-2]
| 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 | Y | | N/A | |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | | GMT-7 | |
### Output parameters [#output-parameters-2]
| Column name | Type | Comment |
| -------------------------- | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Addenda Return Code Date` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | |
| `Account ABA` | string | |
| `Amount` | currency | |
| `Status` | string | |
| `Description` | string | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Result Code Msg` | string | |
| `Customer Ref` | string | |
| `Batch ID` | number | |
| `Currency Symbol` | string | |
## ACH Notification of Change Report [#ach-notification-of-change-report]
Report Name: `ACHNocReport`
### Input parameters [#input-parameters-3]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime
YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | | GMT-7 | |
### Output parameters [#output-parameters-3]
| Column name | Type | Comment |
| -------------------- | ------ | ------- |
| `Account ABA` | string | |
| `Account Number` | string | |
| `New Name` | string | |
| `Account Type` | string | |
| `Noc Type` | string | |
| `Deposit Date` | date | |
| `Change Information` | string | |
## ACH Return Activity Report [#ach-return-activity-report]
Report Name: `ACHReturnActivityReport`
### Input parameters [#input-parameters-4]
| 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 | Y | | | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | | Y |
| `timezone` | Timezone used to interpret times | string | N | | GMT-7 | |
### Output parameters [#output-parameters-4]
| Column name | Type | Comment |
| ----------------- | -------- | ------- |
| `Status Code` | string | |
| `Description` | string | |
| `Total Amount` | currency | |
| `Total Items` | number | |
| `Currency Symbol` | string | |
## ACH Settlement Report [#ach-settlement-report]
Report Name: `ACHSettlementReport`
### Input parameters [#input-parameters-5]
| 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 | Y | | | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | | |
| `timezone` | Time zone to interpret times | string | N | | GMT-7 | |
### Output parameters [#output-parameters-5]
| Column name | Type | Comment |
| ----------------- | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | |
| `Account ABA` | string | |
| `Amount` | currency | |
| `Status` | string | |
| `Description` | string | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Result Code Msg` | string | |
| `Customer Ref` | string | |
| `Batch ID` | number | |
| `Currency Symbol` | string | |
| `Comment1` | string | |
| `Comment2` | string | |
| `Fund Status` | string | |
## ACH Transaction Report [#ach-transaction-report]
Report Name: `ACHTransReport`
### Input parameters [#input-parameters-6]
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
| ------------- | ---------------------------------------------- | ---------------------------- | --------- | ---------------------------------------------------------------------------------- | ------------- | --------------------------- |
| `report_date` | Start date for which report needs to be pulled | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `sort_by` | | string | N | Transaction ID, Transaction Time, Transaction Type, Amount, ResultTransaction Time | | |
| `sort_option` | Sort by ascending or descending | string | N | Descending | No Order | |
| `timezone` | Timezone used to interpret times | string | N | GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-6]
| Column name | Type | Comment |
| ----------------- | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | |
| `Account ABA` | string | |
| `Amount` | currency | |
| `Status` | string | |
| `Description` | string | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Result Code Msg` | string | |
| `Charge Desc` | string | |
| `Customer Ref` | string | |
| `Comment1` | string | |
| `Comment2` | string | |
| `Prenote` | string | |
| `Currency Symbol` | string | |
## Auto Credit Report [#auto-credit-report]
Report Name: `AutoCreditReport`
### Input parameters [#input-parameters-7]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-7]
| Column name | Type | Comment |
| ------------------ | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `AVS Zip Match` | string | |
| `AVS Street Match` | string | |
| `Type` | string | |
| `Tender Type` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Comment1` | string | |
| `Comment2` | string | |
## Auto Delayed Capture Report [#auto-delayed-capture-report]
Report Name: `AutoDelayedCaptureReport`
### Input parameters [#input-parameters-8]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-8]
| Column name | Type | Comment |
| ------------------ | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `AVS Zip Match` | string | |
| `AVS Street Match` | string | |
| `Type` | string | |
| `Tender Type` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Comment1` | string | |
| `Comment2` | string | |
## Auto Resettle Report [#auto-resettle-report]
Report Name: `AutoResettleReport`
### Input parameters [#input-parameters-9]
| 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 | Y | | N/A | |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-9]
| Column name | Type | Comment |
| ------------------ | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `AVS Zip Match` | string | |
| `AVS Street Match` | string | |
| `Type` | string | |
| `Tender Type` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Comment1` | string | |
| `Comment2` | string | |
## Auto Void Report [#auto-void-report]
Report Name: `AutoVoidReport`
### Input parameters [#input-parameters-10]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-10]
| Column name | Type | Comment |
| ------------------ | -------- | ------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `AVS Zip Match` | string | |
| `AVS Street Match` | string | |
| `Type` | string | |
| `Tender Type` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Comment1` | string | |
| `Comment2` | string | |
## Batch ID Report [#batch-id-report]
Report Name: `BatchIDReport`
### Input parameters [#input-parameters-11]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime
YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `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 |
### Output parameters [#output-parameters-11]
| 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 |
## Custom Report [#custom-report]
Report Name: `CustomReport`
### Input parameters [#input-parameters-12]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `minimum_amount` | Minimum amount to report on | number | N | | 0 | N |
| `maximum_amount` | Maximum amount to report on | number | N | | 10000 | N |
| `results` | Results to report on | string | N | All
Approvals Only
Declines Only
Approvals and Declines
| All | N |
| `include_amex` | Include American Express cards in report (PayPal only) | string | N | true
false | true | N |
| `include_diners` | Include Diners cards in report (PayPal only) | string | N | true
false | true | N |
| `include_discover` | Include Discover cards in report (PayPal only) | string | N | true
false | true | N |
| `include_enroute` | Include Enroute cards in report (PayPal only) | string | N | true
false | true | N |
| `include_jcb` | Include JCB cards in report (PayPal only) | string | N | true
false | true | N |
| `include_mastercard` | Include Mastercard cards in report | string | N | true
false | true | N |
| `include_visa` | Include Visa cards in report | string | N | true
false | true | N |
| `include_authorization` | Include Authorizations in report | string | N | true
false | true | N |
| `include_sale` | Include Sales in report | string | N | true
false | true | N |
| `include_delayedcapture` | Include Delayed Captures in report | string | N | true
false | true | N |
| `include_credit` | Include Credits in report | string | N | true
false | true | N |
| `include_void` | Include Voids in report | string | N | true
false | true | N |
| `include_voiceauthorization` | Include Voice Authorizations in report (PayPal only) | string | N | true
false | true | N |
| `include_buyer_authenticated` | Include Buyer Authenticated transactions in report | string | N | true
false | false | N |
| `include_not_buyer_authenticated` | Include Not Buyer Authenticated transactions in report | string | N | true
false | false | N |
| `recurring_only` | Only include recurring transactions in report | string | N | true
false | false | N |
| `sort_by` | Column to sort data by | string | N | Transaction ID, Transaction Time, Transaction Type, Tender Type, Amount, Result | Transaction Time | N |
| `sort_option` | Sort by ascending or descending | string | N | Ascending
Descending | Ascending | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
| `show_order_id` | Return Order ID column in result? | string | N | true
false | true | N |
| `show_transaction_id` | Return Transaction ID column in result? | string | N | true
false | true | N |
| `show_time` | Return Time column in result? | string | N | true
false | true | N |
| `show_type` | Return Type column in result? | string | N | true
false | true | N |
| `show_tender_type` | Return Tender Type column in result? | string | N | true
false | true | N |
| `show_account_number` | Return Account Number column in result? | string | N | true
false | true | N |
| `show_expires` | Return Expires column in result? | string | N | true
false | true | N |
| `show_aba_routing_number` | Return ABA Routing Number column in result? | string | N | true
false | true | N |
| `show_amount` | Return Amount column in result? | string | N | true
false | true | N |
| `show_result_code` | Return Result Code column in result? | string | N | true
false | true | N |
| `show_response_msg` | Return Response Msg column in result? | string | N | true
false | true | N |
| `show_comment1` | Return Comment1 column in result? | string | N | true
false | true | N |
| `show_comment2` | Return Comment2 column in result? | string | N | true
false | true | N |
| `show_tax_amount` | Return Tax Amount column in result? | string | N | true
false | true | N |
| `show_purchase_order` | Return Purchase Order column in result? | string | N | true
false | true | N |
| `show_original_transaction_id` | Return Original Transaction ID column in result? | string | N | true
false | true | N |
| `show_avs_street_match` | Return AVS Street Match column in result? | string | N | true
false | true | N |
| `show_avs_zip_match` | Return AVS Zip Match column in result? | string | N | true
false | true | N |
| `show_invoice_number` | Return Invoice Number column in result? | string | N | true
false | true | N |
| `show_authcode` | Return Authcode column in result? | string | N | true
false | true | N |
| `show_batch_id` | Return Batch ID column in result? | string | N | true
false | true | N |
| `show_csc_match` | Return CSC Match column in result? | string | N | true
false | true | N |
| `show_billing_first_name` | Return Billing First Name column in result? | string | N | true
false | true | N |
| `show_billing_last_name` | Return Billing Last Name column in result? | string | N | true
false | true | N |
| `show_billing_company_name` | Return Billing Company Name column in result? | string | N | true
false | true | N |
| `show_billing_address_1` | Return Billing Address 1 column in result? | string | N | true
false | true | N |
| `show_billing_address_2` | Return Billing Address 2 column in result? | string | N | true
false | true | N |
| `show_billing_city` | Return Billing City column in result? | string | N | true
false | true | N |
| `show_billing_state` | Return Billing State column in result? | string | N | true
false | true | N |
| `show_billing_zip` | Return Billing Zip column in result? | string | N | true
false | true | N |
| `show_billing_email` | Return Billing Email column in result? | string | N | true
false | true | N |
| `show_billing_country` | Return Billing Country column in result? | string | N | true
false | true | N |
| `show_shipping_first_name` | Return Shipping First Name column in result? | string | N | true
false | true | N |
| `show_shipping_last_name` | Return Shipping Last Name column in result? | string | N | true
false | true | N |
| `show_shipping_address_1` | Return Shipping Address 1column in result? | string | N | true
false | true | N |
| `show_shipping_address_2` | Return Shipping Address 2 column in result? | string | N | true
false | true | N |
| `show_shipping_city` | Return Shipping City column in result? | string | N | true
false | true | N |
| `show_shipping_state` | Return Shipping State column in result? | string | N | true
false | true | N |
| `show_shipping_zip` | Return Shipping Zip column in result? | string | N | true
false | true | N |
| `show_shipping_country` | Return Shipping Country column in result? | string | N | true
false | true | N |
| `show_customer_code` | Return Customer Code column in result? | string | N | true
false | true | N |
| `show_freight_amount` | Return Freight Amount column in result? | string | N | true
false | true | N |
| `show_duty_amount` | Return Duty Amount column in result? | string | N | true
false | true | N |
### Output parameters [#output-parameters-12]
| Column name | Type | Comment |
| ------------------------- | -------- | ----------------------------------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | Only the last 4 digits are returned |
| `Expires` | string | |
| `ABA Routing Number` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Comment1` | string | |
| `Comment2` | string | |
| `Tax Amount` | currency | |
| `Purchase Order` | string | |
| `Original Transaction ID` | string | |
| `AVS Street Match` | string | |
| `AVS Zip Match` | string | |
| `Invoice Number` | string | |
| `Authcode` | string | |
| `Batch ID` | number | |
| `CSC Match` | string | |
| `Billing First Name` | string | |
| `Billing Last Name` | string | |
| `Billing Company Name` | string | |
| `Billing Address1` | string | |
| `Billing Address2` | string | |
| `Billing City` | string | |
| `Billing State` | string | |
| `Billing Zip` | string | |
| `Billing Email` | string | |
| `Billing Country` | string | |
| `Shipping First Name` | string | |
| `Shipping Last Name` | string | |
| `Shipping Address1` | string | |
| `Shipping Address2` | string | |
| `Shipping City` | string | |
| `Shipping State` | string | |
| `Shipping Zip` | string | |
| `Shipping Country` | string | |
| `Customer Code` | string | |
| `Freight Amount` | currency | |
| `Duty Amount` | currency | |
## Daily Activity Report [#daily-activity-report]
Report Name: `DailyActivityReport`
### Input parameters [#input-parameters-13]
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
| ------------- | -------------------------------- | --------------- | --------- | ------------------------------------------------------------------------------- | ------------- | --------------------------- |
| `report_date` | Date to run report for | date YYYY-MM-DD | Y | | N/A | Y |
| `sort_by` | Column to sort data by | string | N | Transaction ID, Transaction Time, Transaction Type, Tender Type, Amount, Result | Trans Time | N |
| `sort_option` | Sort by ascending or descending | string | N | Ascending
Descending | Ascending | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
Currency values are returned in the three-character currency code specified. The values are:
* USD (US dollar) (default value)
* EUR (Euro)
* GBP (UK pound)
* CAD (Canadian dollar)
* JPY (Japanese Yen)
* AUD (Australian dollar)
### Output parameters [#output-parameters-13]
| Column name | Type | Comment |
| ------------------ | -------- | ----------------------------------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | Only the last 4 digits are returned |
| `Expires` | string | |
| `Amount` | currency | |
| `Result` | number | |
| `Response Msg` | string | |
| `Comment1` | string | |
| `Comment2` | string | |
| `Client IP` | string | |
| `Authcode` | string | |
| `AVS Street Match` | string | |
| `AVS Zip Match` | string | |
## Filter Scorecard Report [#filter-scorecard-report]
Report Name: `FilterScorecardReport`
### Input parameters [#input-parameters-14]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-14]
| Column name | Type |
| -------------------- | ------ |
| `Filter` | string |
| `Times Triggered` | number |
| `Trigger Percentage` | number |
## Fraud Protection Report [#fraud-protection-report]
Report Name: `FraudProtectionReport`
> **Note:** **Note:** Run this report to get the fraud transaction ID before running [FraudTransactionSearch](/api/nvp-soap/payflow/reports/search-parameters).
### Input parameters [#input-parameters-15]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime
YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `transaction_type` | Transaction types to report on | string | Y | Review
Reject
Accept
Screened By Filters
Not Screened By Filters | N/A | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-15]
| Column name | Type |
| ------------------- | -------- |
| `Transaction ID` | string |
| `Time` | date |
| `Type` | string |
| `Tender Type` | string |
| `Amount` | currency |
| `Deployment Mode` | string |
| `Fraud Transaction` | string |
## Payflow Link Orders Report [#payflow-link-orders-report]
Report Name: `PayflowLinkOrdersReport`
### Input parameters [#input-parameters-16]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-16]
| Column name | Type |
| ------------------- | -------- |
| `Time` | date |
| `Transaction ID` | string |
| `Billing Name` | string |
| `Billing Address1` | string |
| `Billing Address2` | string |
| `Billing City` | string |
| `Billing State` | string |
| `Billing Zip` | string |
| `Billing Country` | string |
| `Billing Phone` | string |
| `Billing Fax` | string |
| `Billing Email` | string |
| `Shipping Name` | string |
| `Shipping Address1` | string |
| `Shipping Address2` | string |
| `Shipping City` | string |
| `Shipping State` | string |
| `Shipping Zip` | string |
| `Shipping Country` | string |
| `Shipping Phone` | string |
| `Shipping Fax` | string |
| `Shipping Email` | string |
| `Amount` | currency |
| `Tax Amount` | currency |
| `Ship Amount` | currency |
| `Description` | string |
| `Type` | string |
| `Result Code` | number |
## PayPal Settlement Summary Report [#paypal-settlement-summary-report]
Report Name: `PayPalSettlementSummaryReport`
### Input parameters [#input-parameters-17]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime
YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-17]
| Column name | Type | Comment |
| --------------------------------- | -------- | --------------------------------------------------------- |
| `Date` | date | |
| `Sales and Delay Captures Number` | number | |
| `Sales and Delay Captures Amount` | currency | Values are returned in the specified, supported currency. |
| `Credits Number` | number | |
| `Credits Amount` | currency | |
| `Fees Amount` | currency | |
| `Net Amount` | currency | |
| `Currency Symbol` | string | |
## Recurring Billing Profile by Next Payment Report [#recurring-billing-profile-by-next-payment-report]
Report Name: `RBProfileNPDReport`
### Input parameters [#input-parameters-18]
| 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 | Y | Current and future date/time values | N/A | Y |
| `end_date` | End date to run report for | datetime - YYYY-MM-DD HH:MI:SS | Y | Current and future date/time values | N/A | Y |
### Output parameters [#output-parameters-18]
| Column name | Type |
| ----------------------- | -------------------------------------------- |
| `Profile ID` | number |
| `Profile Name` | string |
| `Last Name` | string |
| `Status` | number |
| `Account Number` | string - Only the last 4 digits are returned |
| `Expires` | string |
| `Amount` | currency |
| `Established Date` | date |
| `Start Date` | date |
| `Frequency` | string |
| `Terms` | number |
| `Next Payment Date` | date |
| `Deactivation Date` | date |
| `Profile Modified Date` | date |
## Recurring Billing Profile by Modified Date Report [#recurring-billing-profile-by-modified-date-report]
Report Name: `RBProfilePMDReport`
### Input parameters [#input-parameters-19]
| 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 | Y | Current and future date/time values | N/A | Y |
| `end_date` | End date to run report for | datetime - YYYY-MM-DD HH:MI:SS | Y | Current and future date/time values | N/A | Y |
### Output parameters [#output-parameters-19]
| Column name | Type |
| ----------------------- | -------------------------------------------- |
| `Profile ID` | number |
| `Profile Name` | string |
| `Last Name` | string |
| `Status` | number |
| `Account Number` | string - Only the last 4 digits are returned |
| `Expires` | string |
| `Amount` | currency |
| `Established Date` | date |
| `Start Date` | date |
| `Frequency` | string |
| `Terms` | number |
| `Next Payment Date` | date |
| `Deactivation Date` | date |
| `Profile Modified Date` | date |
## Recurring Billing Report [#recurring-billing-report]
Report Name: `RecurringBillingReport`
### Input parameters [#input-parameters-20]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime - YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `include_approvals` | Incl approvals in report | string | N | true
false | true | N |
| `include_declines` | Include declines in report | string | N | true
false | true | N |
| `timezone` | Timezone to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
| `tender_type` | Run report for ACH or Credit | string | N | ACH
Credit | Credit | N |
### Output parameters [#output-parameters-20]
| Column name | Type |
| ---------------- | ------ |
| `Profile Name` | string |
| `Profile ID` | string |
| `Status` | string |
| `Payment Number` | number |
| `Retry Number` | number |
| `Time` | date |
| `Retry Reason` | string |
| `Retry Flag` | number |
| `Transaction ID` | string |
| `Result Code` | number |
## Recurring Profile Failed Report [#recurring-profile-failed-report]
Report Name: `RecurringProfileFailedReport`
### Input parameters [#input-parameters-21]
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
| ------------ | -------------------------------- | --------------- | --------- | ------------------------------------------------------ | ------------- | --------------------------- |
| `start_date` | Start date to run report for | date YYYY-MM-DD | Y | | N/A | Y |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-21]
| Column name | Type |
| ---------------- | ------ |
| `Profile Name` | string |
| `Profile ID` | string |
| `Status` | string |
| `Payment Number` | number |
| `Retry Number` | number |
| `Time` | date |
| `Retry Reason` | string |
| `Retry Flag` | number |
| `Transaction ID` | string |
| `Result Code` | number |
## Recurring Profile Report [#recurring-profile-report]
Report Name: `RecurringProfileReport`
### Input parameters [#input-parameters-22]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `profile_id` | Profile to report on | string | Y | | N/A | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
| `tender_type` | Run report for ACH or Credit | string | N | ACH
Credit | Credit | N |
### Output parameters [#output-parameters-22]
| Column name | Type | |
| ---------------- | ------ | - |
| `Profile Name` | string | |
| `Profile ID` | string | |
| `Status` | string | |
| `Payment Number` | number | |
| `Retry Number` | number | |
| `Time` | date | |
| `Retry Reason` | string | |
| `Retry Flag` | number | |
| `Transaction ID` | string | |
| `Result Code` | number | |
## Settlement Report [#settlement-report]
Report Name: `SettlementReport`
### Input parameters [#input-parameters-23]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `processor` | Processor to report on | string | Y | Name of the processor for which the settlement report is requested | N/A | N |
| `settlement_status` | Settled or non-settled transactions | string | N | Settled
Unsettled
All | All | N |
| `transaction_type` | Transaction types to report on | string | N | Sales
Credits
All | All | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-23]
| Column name | Type | Comment |
| ----------------------- | -------- | ---------------------------------------------------------------------------------------------- |
| `Transaction ID` | string | |
| `Time` | date | |
| `Type` | string | |
| `Tender Type` | string | |
| `Account Number` | string | Only the last 4 digits are returned |
| `Expires` | string | |
| `Amount` | currency | |
| `Result Code` | number | |
| `Response Msg` | string | |
| `Comment1` | string | |
| `Comment2` | string | |
| `Batch ID` | number | |
| `Currency Symbol` | string | Alphabetic currency symbol, for example USD |
| `PayPal Transaction ID` | string | Returned only if merchant has a PayPal Internet Merchant Account |
| `PayPal Fees` | currency | Returned only if merchant has a PayPal Internet Merchant Account |
| `PayPal Email ID` | string | Buyer's PayPal email address; returned only if merchant has a PayPal Internet Merchant Account |
## Shipping and Billing Report [#shipping-and-billing-report]
Report Name: `ShippingAndBillingReport`
### Input parameters [#input-parameters-24]
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
| ------------- | -------------------------------- | --------------- | --------- | ------------------------------------------------------------------------------- | ------------- | --------------------------- |
| `report_date` | Date to run report for | date YYYY-MM-DD | Y | | N/A | Y |
| `sort_by` | Column to sort data by | string | N | Transaction ID, Transaction Time, Transaction Type, Tender Type, Amount, Result | Trans Time | N |
| `sort_option` | Sort by ascending or descending | string | N | Ascending
Descending | Ascending | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-24]
| Column name | Type | Comment |
| ---------------------- | -------- | ------- |
| `Time` | date | |
| `Transaction ID` | string | |
| `Captured` | string | |
| `Type` | string | |
| `Billing First Name` | string | |
| `Billing Last Name` | string | |
| `Billing Company Name` | string | |
| `Billing Address1` | string | |
| `Billing Address2` | string | |
| `Billing City` | string | |
| `Billing State` | string | |
| `Billing Zip` | string | |
| `Billing Email` | string | |
| `Billing Country` | string | |
| `Shipping First Name` | string | |
| `Shipping Last Name` | string | |
| `Shipping Address1` | string | |
| `Shipping Address2` | string | |
| `Shipping City` | string | |
| `Shipping State` | string | |
| `Shipping Zip` | string | |
| `Shipping Country` | string | |
| `Purchase Order` | string | |
| `Customer Code` | string | |
| `Tax Amount` | currency | |
| `Freight Amount` | currency | |
| `Duty Amount` | currency | |
| `Total Amount` | currency | |
## Transaction Summary Report [#transaction-summary-report]
Report Name: `TransactionSummaryReport`
### Input parameters [#input-parameters-25]
| 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 | Y | | N/A | Y |
| `end_date` | End date to run report for | datetime
YYYY-MM-DD HH:MI:SS | Y | | N/A | Y |
| `settlement_status` | Settled or non-settled transactions | string | N | Settled
Unsettled
All | All | N |
| `timezone` | Timezone used to interpret times | string | N | GMT
GMT ± XX:XX | GMT | N |
### Output parameters [#output-parameters-25]
| Column name | Type |
| ------------------ | -------- |
| `Transaction Type` | string |
| `Processor` | string |
| `Trans Count` | number |
| `Result Code` | number |
| `Tender Type` | string |
| `Min Amount` | currency |
| `Max Amount` | currency |
| `Average` | currency |
| `Total Amount` | currency |