Search Parameters

DocsCurrent


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

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
transaction_idTransaction ID to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Order IDstring
Transaction IDstring
Merchantstring
User Namestring
Timestring
Typestring
Durationnumber
Tender Typestring
Client IP Addressstring
Account NumberstringOnly the last 4 digits are returned
Client Versionstring
Expiresstring
Amountcurrency
Comment1string
Comment2string
Billing First Namestring
Billing Last Namestring
Billing Address1string
Billing Address2string
Billing Citystring
Billing Statestring
Billing Zipstring
Billing Countrystring
Billing Emailstring
Shipping First Namestring
Shipping Last Namestring
Shipping Address1string
Shipping Address2string
Shipping Citystring
Shipping Statestring
Shipping Zipstring
Shipping Countrystring
Recurringstring
Result Codenumber
Response Msgstring
Authcodestring
Original Transaction IDstring
AVS Street Matchstring
Original Amountcurrency
AVS Zip Matchstring
International AVS Indicatorstring
CSC Matchstring
Batch IDnumber

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
batch_idBatch ID to search forstringY
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timestring
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

AccountNumberSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
account_numberAccount Number to search forstringY
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timestring
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

CommentSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
comment1Comment1 to search forstringY (One or both of comment1 and comment2 are required)Comment1Comment1 to search forstring
comment2Comment2 to search forstringY (One or both of comment1 and comment2 are required)Comment2Comment2 to search forstring
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSYstart_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SS
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSYend_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SS
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timestring
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

AccountNumberRefSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
transaction_idTransaction ID to search forstringY
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Order IDstringOnly if CyberCash merchant
Transaction IDstring
Timestring
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

PurchaseOrderSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
purchase_order_numPurchase Order Number to search forstringY
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timestring
Typestring
Tender Typestring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

RecurringBillingProfileIDSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
profile_idProfile ID to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Profile IDstring
Profile Namestring
Namestring
Addressstring
Phone Numberstring
Emailstring
Recurring Amountcurrency
Original Start Datedate
Termnumber
Frequencystring
Statusstring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Commentstring
Start Datedate
Next Payment Datedate
Last Datedate
Date Establisheddate

RecurringBillingProfileNameSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
profile_nameProfile Name to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Profile Namestring
Profile IDstring
Statusstring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Frequencystring
Start Datedate
Date Establisheddate

RecurringBillingAccountNumberSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
account_numberAccount number to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Profile Namestring
Profile IDstring
Statusstring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Frequencystring
Start Datedate
Date Establisheddate

RecurringBillingCommentSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
commentComment to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Profile Namestring
Profile IDstring
Statusstring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Frequencystring
Start Datedate
Date Establisheddate

RecurringBillingAmountSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
amountAmount to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Profile Namestring
Profile IDstring
Statusstring
Account NumberstringOnly the last 4 digits are returned
Expiresstring
Amountcurrency
Frequencystring
Start Datedate
Date Establisheddate

FraudTransactionSearch

Important: Run a Fraud Protection Report to get the fraud transaction ID before running this search.

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
fraud_transaction_idtransaction ID to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Transaction IDstring
Timestring
Return Code Messagestring
Customer Namestring
Email Addressstring
Phone Numberstring
Amountcurrency
Total Itemsnumber
SKUstring
Account NumberstringOnly the last 4 digits are returned
AVS Street Matchstring
AVS Zip Matchstring
CSC Matchstring
International AVS Indicatorstring
Buyer Authenticationstring
Billing Namestring
Billing Street1string
Billing Street2string
Billing Citystring
Billing Statestring
Billing Zipstring
Billing Countrystring
Shipping Namestring
Shipping Street1string
Shipping Street2string
Shipping Citystring
Shipping Statestring
Shipping Zipstring
Shipping Countrystring
Client IP Addressstring
Num Custom Rulesnumber
Custom Rulesstring
Num Triggered Rulesnumber
Triggered Rulesstring
Num Unprocessed Rulesnumber
Unprocessed Rulesstring

OrderIDSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
order_idOrder ID to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
Order IDstring
Transaction IDstring
Merchantstring
Timestring
Typestring
Durationnumber
Tender Typestring
Client IP Addressstring
Account NumberstringOnly the last 4 digits are returned
Client Versionstring
Expiresstring
Streetstring
Amountcurrency
Zipstring
Emailstring
Name On Cardstring
Comment1string
Comment2string
Result Codenumber
Response Msgstring
Authcodestring
Original Transaction IDstring
AVS Street Matchstring
Original Amountcurrency
AVS Zip Matchstring
Batch IDnumber
AVS Result Codestring

PayPalTransactionIDSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
paypal_transaction_idPayPal transaction ID to search forstringY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
PayPal Transaction IDstringUnique transaction ID of the payment returned in a DoExpressCheckoutPayment response
Transaction IDstring
Timestring
Typestring
Tender Typestring
Emailstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

PayPalEmailSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
emailEmail address to search forstringY
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
PayPal Transaction IDstring
Transaction IDstring
Timestring
Typestring
Tender Typestring
Emailstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string

PayPalNameSearch

Input parameters

NameDescriptionTypeRequired?Allowed valuesDefault valueAuto-computed by scheduler?
last_nameLast name to search forstringY
first_nameFirst name to search forstringN
start_dateStart date to search fordatetime - YYYY-MM-DD HH:MI:SSY
end_dateEnd date to search fordatetime - YYYY-MM-DD HH:MI:SSY
timezoneTimezone used to interpret timesstringNGMT
GMT±XX:XX
GMTN

Output parameters

Column nameTypeComment
PayPal Transaction IDstringUnique transaction ID of the payment returned in a DoExpressCheckoutPayment response
Transaction IDstring
\1string
Typestring
Tender Typestring
Emailstring
Amountcurrency
Response Msgstring
Comment1string
Comment2string