Report Parameters

DocsCurrent


The input and output parameters of the following reports are included here.

ACH Activity Summary Report

Report Name: ACHActivitySummaryReport

Input parameters

NameDescriptionTypeRequired?Allowed valueDefault valueAuto computed by scheduler?
report_dateDate for which report needs to be pulleddatetime YYYY-MM-DD HH:MI:SSYN/AY
sort_byColumn to sort data bystringNTransaction ID, Transaction Time, Transaction Type, Tender Type, Amount, ResultTransaction Time
sort_optionSort by ascending or descending orderstringNDescendingNo Order
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:
GMT7
include_pending_settlementstringNtrue, falseTRUE
include_settledstringNtrue, falseTRUE
include_failedstringNtrue, falseTRUE

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account Numberstring
Account ABAstring
Amountcurrency
Statusstring
Descriptionstring
Result Codenumber
Response Msgstring
Result Code Msgstring
Customer Refstring
Currency Symbolstring

ACH Batch ID Report

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT-7
host_typenumberY68
batch_idnumberN
BatchByCardstringNtrue, falseFALSE
batch_typestringNConsumer Batch, Merchant BatchMerchant Batch

Output parameters

Column nameTypeComment
Host Typenumber
Batch IDnumber
Tender TypestringIf BatchByCard is given as TRUE in input
Settled Datedate
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 Amountcurrency
Total Countstring
Currency Symbolstring
Begin Timedate
End Timedate

ACH Detail Return Activity Report

Report Name: ACHDetailReturnActivityReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/A
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT-7

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Addenda Return Code Datedate
Typestring
Tender Typestring
Account Numberstring
Account ABAstring
Amountcurrency
Statusstring
Descriptionstring
Result Codenumber
Response Msgstring
Result Code Msgstring
Customer Refstring
Batch IDnumber
Currency Symbolstring

ACH Notification of Change Report

Report Name: ACHNocReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
end_dateEnd date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
timezoneTimezone used to interpret timesstringNGMT-7

Output parameters

Column nameTypeComment
Account ABAstring
Account Numberstring
New Namestring
Account Typestring
Noc Typestring
Deposit Datedate
Change Informationstring

ACH Return Activity Report

Report Name: ACHReturnActivityReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYY
timezoneTimezone used to interpret timesstringNGMT-7

Output parameters

Column nameTypeComment
Status Codestring
Descriptionstring
Total Amountcurrency
Total Itemsnumber
Currency Symbolstring

ACH Settlement Report

Report Name: ACHSettlementReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSY
timezoneTime zone to interpret timesstringNGMT-7

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account Numberstring
Account ABAstring
Amountcurrency
Statusstring
Descriptionstring
Result Codenumber
Response Msgstring
Result Code Msgstring
Customer Refstring
Batch IDnumber
Currency Symbolstring
Comment1string
Comment2string
Fund Statusstring

ACH Transaction Report

Report Name: ACHTransReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
report_dateStart date for which report needs to be pulleddatetime YYYY-MM-DD HH:MI:SSYN/AY
sort_bystringNTransaction ID, Transaction Time, Transaction Type, Amount, ResultTransaction Time
sort_optionSort by ascending or descendingstringNDescendingNo Order
timezoneTimezone used to interpret timesstringNGMT±XX:XXGMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account Numberstring
Account ABAstring
Amountcurrency
Statusstring
Descriptionstring
Result Codenumber
Response Msgstring
Result Code Msgstring
Charge Descstring
Customer Refstring
Comment1string
Comment2string
Prenotestring
Currency Symbolstring

Auto Credit Report

Report Name: AutoCreditReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
AVS Zip Matchstring
AVS Street Matchstring
Typestring
Tender Typestring
Amountcurrency
Result Codenumber
Comment1string
Comment2string

Auto Delayed Capture Report

Report Name: AutoDelayedCaptureReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
AVS Zip Matchstring
AVS Street Matchstring
Typestring
Tender Typestring
Amountcurrency
Result Codenumber
Comment1string
Comment2string

Auto Resettle Report

Report Name: AutoResettleReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/A
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
AVS Zip Matchstring
AVS Street Matchstring
Typestring
Tender Typestring
Amountcurrency
Result Codenumber
Comment1string
Comment2string

Auto Void Report

Report Name: AutoVoidReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
AVS Zip Matchstring
AVS Street Matchstring
Typestring
Tender Typestring
Amountcurrency
Result Codenumber
Comment1string
Comment2string

Batch ID Report

Report Name: BatchIDReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
end_dateEnd date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
processorProcessor to report onstringYPayPalN/AN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN
group_by_tenderShould group results by tender?stringNtrue
false
falseN

Output parameters

Column nameTypeComment
Batch IDnumberOnly if group_by_tender is set to true
Settled Datedate
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 Amountcurrency
Total Countnumber
tender_typestringOnly if group-by-tender is set to true

Custom Report

Report Name: CustomReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
minimum_amountMinimum amount to report onnumberN0N
maximum_amountMaximum amount to report onnumberN10000N
resultsResults to report onstringNAll
Approvals Only
Declines Only
Approvals and Declines
AllN
include_amexInclude American Express cards in report (PayPal only)stringNtrue
false
trueN
include_dinersInclude Diners cards in report (PayPal only)stringNtrue
false
trueN
include_discoverInclude Discover cards in report (PayPal only)stringNtrue
false
trueN
include_enrouteInclude Enroute cards in report (PayPal only)stringNtrue
false
trueN
include_jcbInclude JCB cards in report (PayPal only)stringNtrue
false
trueN
include_mastercardInclude Mastercard cards in reportstringNtrue
false
trueN
include_visaInclude Visa cards in reportstringNtrue
false
trueN
include_authorizationInclude Authorizations in reportstringNtrue
false
trueN
include_saleInclude Sales in reportstringNtrue
false
trueN
include_delayedcaptureInclude Delayed Captures in reportstringNtrue
false
trueN
include_creditInclude Credits in reportstringNtrue
false
trueN
include_voidInclude Voids in reportstringNtrue
false
trueN
include_voiceauthorizationInclude Voice Authorizations in report (PayPal only)stringNtrue
false
trueN
include_buyer_authenticatedInclude Buyer Authenticated transactions in reportstringNtrue
false
falseN
include_not_buyer_authenticatedInclude Not Buyer Authenticated transactions in reportstringNtrue
false
falseN
recurring_onlyOnly include recurring transactions in reportstringNtrue
false
falseN
sort_byColumn to sort data bystringNTransaction ID, Transaction Time, Transaction Type, Tender Type, Amount, ResultTransaction TimeN
sort_optionSort by ascending or descendingstringNAscending
Descending
AscendingN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN
show_order_idReturn Order ID column in result?stringNtrue
false
trueN
show_transaction_idReturn Transaction ID column in result?stringNtrue
false
trueN
show_timeReturn Time column in result?stringNtrue
false
trueN
show_typeReturn Type column in result?stringNtrue
false
trueN
show_tender_typeReturn Tender Type column in result?stringNtrue
false
trueN
show_account_numberReturn Account Number column in result?stringNtrue
false
trueN
show_expiresReturn Expires column in result?stringNtrue
false
trueN
show_aba_routing_numberReturn ABA Routing Number column in result?stringNtrue
false
trueN
show_amountReturn Amount column in result?stringNtrue
false
trueN
show_result_codeReturn Result Code column in result?stringNtrue
false
trueN
show_response_msgReturn Response Msg column in result?stringNtrue
false
trueN
show_comment1Return Comment1 column in result?stringNtrue
false
trueN
show_comment2Return Comment2 column in result?stringNtrue
false
trueN
show_tax_amountReturn Tax Amount column in result?stringNtrue
false
trueN
show_purchase_orderReturn Purchase Order column in result?stringNtrue
false
trueN
show_original_transaction_idReturn Original Transaction ID column in result?stringNtrue
false
trueN
show_avs_street_matchReturn AVS Street Match column in result?stringNtrue
false
trueN
show_avs_zip_matchReturn AVS Zip Match column in result?stringNtrue
false
trueN
show_invoice_numberReturn Invoice Number column in result?stringNtrue
false
trueN
show_authcodeReturn Authcode column in result?stringNtrue
false
trueN
show_batch_idReturn Batch ID column in result?stringNtrue
false
trueN
show_csc_matchReturn CSC Match column in result?stringNtrue
false
trueN
show_billing_first_nameReturn Billing First Name column in result?stringNtrue
false
trueN
show_billing_last_nameReturn Billing Last Name column in result?stringNtrue
false
trueN
show_billing_company_nameReturn Billing Company Name column in result?stringNtrue
false
trueN
show_billing_address_1Return Billing Address 1 column in result?stringNtrue
false
trueN
show_billing_address_2Return Billing Address 2 column in result?stringNtrue
false
trueN
show_billing_cityReturn Billing City column in result?stringNtrue
false
trueN
show_billing_stateReturn Billing State column in result?stringNtrue
false
trueN
show_billing_zipReturn Billing Zip column in result?stringNtrue
false
trueN
show_billing_emailReturn Billing Email column in result?stringNtrue
false
trueN
show_billing_countryReturn Billing Country column in result?stringNtrue
false
trueN
show_shipping_first_nameReturn Shipping First Name column in result?stringNtrue
false
trueN
show_shipping_last_nameReturn Shipping Last Name column in result?stringNtrue
false
trueN
show_shipping_address_1Return Shipping Address 1column in result?stringNtrue
false
trueN
show_shipping_address_2Return Shipping Address 2 column in result?stringNtrue
false
trueN
show_shipping_cityReturn Shipping City column in result?stringNtrue
false
trueN
show_shipping_stateReturn Shipping State column in result?stringNtrue
false
trueN
show_shipping_zipReturn Shipping Zip column in result?stringNtrue
false
trueN
show_shipping_countryReturn Shipping Country column in result?stringNtrue
false
trueN
show_customer_codeReturn Customer Code column in result?stringNtrue
false
trueN
show_freight_amountReturn Freight Amount column in result?stringNtrue
false
trueN
show_duty_amountReturn Duty Amount column in result?stringNtrue
false
trueN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
ABA Routing Numberstring
Amountcurrency
Result Codenumber
Response Msgstring
Comment1string
Comment2string
Tax Amountcurrency
Purchase Orderstring
Original Transaction IDstring
AVS Street Matchstring
AVS Zip Matchstring
Invoice Numberstring
Authcodestring
Batch IDnumber
CSC Matchstring
Billing First Namestring
Billing Last Namestring
Billing Company Namestring
Billing Address1string
Billing Address2string
Billing Citystring
Billing Statestring
Billing Zipstring
Billing Emailstring
Billing Countrystring
Shipping First Namestring
Shipping Last Namestring
Shipping Address1string
Shipping Address2string
Shipping Citystring
Shipping Statestring
Shipping Zipstring
Shipping Countrystring
Customer Codestring
Freight Amountcurrency
Duty Amountcurrency

Daily Activity Report

Report Name: DailyActivityReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
report_dateDate to run report fordate YYYY-MM-DDYN/AY
sort_byColumn to sort data bystringNTransaction ID, Transaction Time, Transaction Type, Tender Type, Amount, ResultTrans TimeN
sort_optionSort by ascending or descendingstringNAscending
Descending
AscendingN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

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

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Resultnumber
Response Msgstring
Comment1string
Comment2string
Client IPstring
Authcodestring
AVS Street Matchstring
AVS Zip Matchstring

Filter Scorecard Report

Report Name: FilterScorecardReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameType
Filterstring
Times Triggerednumber
Trigger Percentagenumber

Fraud Protection Report

Report Name: FraudProtectionReport

Note: Run this report to get the fraud transaction ID before running FraudTransactionSearch.

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
end_dateEnd date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
transaction_typeTransaction types to report onstringYReview
Reject
Accept
Screened By Filters
Not Screened By Filters
N/AN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameType
Transaction IDstring
Timedate
Typestring
Tender Typestring
Amountcurrency
Deployment Modestring
Fraud Transactionstring

Report Name: PayflowLinkOrdersReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameType
Timedate
Transaction IDstring
Billing Namestring
Billing Address1string
Billing Address2string
Billing Citystring
Billing Statestring
Billing Zipstring
Billing Countrystring
Billing Phonestring
Billing Faxstring
Billing Emailstring
Shipping Namestring
Shipping Address1string
Shipping Address2string
Shipping Citystring
Shipping Statestring
Shipping Zipstring
Shipping Countrystring
Shipping Phonestring
Shipping Faxstring
Shipping Emailstring
Amountcurrency
Tax Amountcurrency
Ship Amountcurrency
Descriptionstring
Typestring
Result Codenumber

PayPal Settlement Summary Report

Report Name: PayPalSettlementSummaryReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
end_dateEnd date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Datedate
Sales and Delay Captures Numbernumber
Sales and Delay Captures AmountcurrencyValues are returned in the specified, supported currency.
Credits Numbernumber
Credits Amountcurrency
Fees Amountcurrency
Net Amountcurrency
Currency Symbolstring

Recurring Billing Profile by Next Payment Report

Report Name: RBProfileNPDReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime - YYYY-MM-DD HH:MI:SSYCurrent and future date/time valuesN/AY
end_dateEnd date to run report fordatetime - YYYY-MM-DD HH:MI:SSYCurrent and future date/time valuesN/AY

Output parameters

Column nameType
Profile IDnumber
Profile Namestring
Last Namestring
Statusnumber
Account Numberstring - Only the last 4 digits are returned
Expiresstring
Amountcurrency
Established Datedate
Start Datedate
Frequencystring
Termsnumber
Next Payment Datedate
Deactivation Datedate
Profile Modified Datedate

Recurring Billing Profile by Modified Date Report

Report Name: RBProfilePMDReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime - YYYY-MM-DD HH:MI:SSYCurrent and future date/time valuesN/AY
end_dateEnd date to run report fordatetime - YYYY-MM-DD HH:MI:SSYCurrent and future date/time valuesN/AY

Output parameters

Column nameType
Profile IDnumber
Profile Namestring
Last Namestring
Statusnumber
Account Numberstring - Only the last 4 digits are returned
Expiresstring
Amountcurrency
Established Datedate
Start Datedate
Frequencystring
Termsnumber
Next Payment Datedate
Deactivation Datedate
Profile Modified Datedate

Recurring Billing Report

Report Name: RecurringBillingReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime - YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime - YYYY-MM-DD HH:MI:SSYN/AY
include_approvalsIncl approvals in reportstringNtrue
false
trueN
include_declinesInclude declines in reportstringNtrue
false
trueN
timezoneTimezone to interpret timesstringNGMT
GMT±XX:XX
GMTN
tender_typeRun report for ACH or CreditstringNACH
Credit
CreditN

Output parameters

Column nameType
Profile Namestring
Profile IDstring
Statusstring
Payment Numbernumber
Retry Numbernumber
Timedate
Retry Reasonstring
Retry Flagnumber
Transaction IDstring
Result Codenumber

Recurring Profile Failed Report

Report Name: RecurringProfileFailedReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordate YYYY-MM-DDYN/AY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameType
Profile Namestring
Profile IDstring
Statusstring
Payment Numbernumber
Retry Numbernumber
Timedate
Retry Reasonstring
Retry Flagnumber
Transaction IDstring
Result Codenumber

Recurring Profile Report

Report Name: RecurringProfileReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
profile_idProfile to report onstringYN/AN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN
tender_typeRun report for ACH or CreditstringNACH
Credit
CreditN

Output parameters

Column nameType
Profile Namestring
Profile IDstring
Statusstring
Payment Numbernumber
Retry Numbernumber
Timedate
Retry Reasonstring
Retry Flagnumber
Transaction IDstring
Result Codenumber

Settlement Report

Report Name: SettlementReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
end_dateEnd date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AY
processorProcessor to report onstringYName of the processor for which the settlement report is requestedN/AN
settlement_statusSettled or non-settled transactionsstringNSettled
Unsettled
All
AllN
transaction_typeTransaction types to report onstringNSales
Credits
All
AllN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timedate
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Result Codenumber
Response Msgstring
Comment1string
Comment2string
Batch IDnumber
Currency SymbolstringAlphabetic currency symbol, for example USD
PayPal Transaction IDstringReturned only if merchant has a PayPal Internet Merchant Account
PayPal FeescurrencyReturned only if merchant has a PayPal Internet Merchant Account
PayPal Email IDstringBuyer’s PayPal email address; returned only if merchant has a PayPal Internet Merchant Account

Shipping and Billing Report

Report Name: ShippingAndBillingReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
report_dateDate to run report fordate YYYY-MM-DDYN/AY
sort_byColumn to sort data bystringNTransaction ID, Transaction Time, Transaction Type, Tender Type, Amount, ResultTrans TimeN
sort_optionSort by ascending or descendingstringNAscending
Descending
AscendingN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Timedate
Transaction IDstring
Capturedstring
Typestring
Billing First Namestring
Billing Last Namestring
Billing Company Namestring
Billing Address1string
Billing Address2string
Billing Citystring
Billing Statestring
Billing Zipstring
Billing Emailstring
Billing Countrystring
Shipping First Namestring
Shipping Last Namestring
Shipping Address1string
Shipping Address2string
Shipping Citystring
Shipping Statestring
Shipping Zipstring
Shipping Countrystring
Purchase Orderstring
Customer Codestring
Tax Amountcurrency
Freight Amountcurrency
Duty Amountcurrency
Total Amountcurrency

Transaction Summary Report

Report Name: TransactionSummaryReport

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
start_dateStart date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
end_dateEnd date to run report fordatetime
YYYY-MM-DD HH:MI:SS
YN/AY
settlement_statusSettled or non-settled transactionsstringNSettled
Unsettled
All
AllN
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameType
Transaction Typestring
Processorstring
Trans Countnumber
Result Codenumber
Tender Typestring
Min Amountcurrency
Max Amountcurrency
Averagecurrency
Total Amountcurrency