Search Parameters
DocsCurrent
Last updated: Sept 18th, 9:20pm
The input and output parameters of the following searches are included here.
- Transaction ID Search
- Batch ID Search
- AccountNumberSearch
- CommentSearch
- AccountNumberRefSearch
- PurchaseOrderSearch
- RecurringBillingProfileIDSearch
- RecurringBillingProfileNameSearch
- RecurringBillingAccountNumberSearch
- RecurringBillingCommentSearch
- RecurringBillingAmountSearch
- FraudTransactionSearch
- OrderIDSearch
- PayPalTransactionIDSearch
- PayPalEmailSearch
- PayPalNameSearch
Transaction ID Search
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
transaction_id |
Transaction ID to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Order ID |
string | |
Transaction ID |
string | |
Merchant |
string | |
User Name |
string | |
Time |
string | |
Type |
string | |
Duration |
number | |
Tender Type |
string | |
Client IP Address |
string | |
Account Number |
string | Only the last 4 digits are returned |
Client Version |
string | |
Expires |
string | |
Amount |
currency | |
Comment1 |
string | |
Comment2 |
string | |
Billing First Name |
string | |
Billing Last Name |
string | |
Billing Address1 |
string | |
Billing Address2 |
string | |
Billing City |
string | |
Billing State |
string | |
Billing Zip |
string | |
Billing Country |
string | |
Billing Email |
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 | |
Recurring |
string | |
Result Code |
number | |
Response Msg |
string | |
Authcode |
string | |
Original Transaction ID |
string | |
AVS Street Match |
string | |
Original Amount |
currency | |
AVS Zip Match |
string | |
International AVS Indicator |
string | |
CSC Match |
string | |
Batch ID |
number |
Batch ID Search
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
batch_id |
Batch ID to search for | string | Y | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
AccountNumberSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
account_number |
Account Number to search for | string | Y | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
CommentSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
comment1 |
Comment1 to search for | string | Y (One or both of comment1 and comment2 are required) |
Comment1 |
Comment1 to search for | string |
comment2 |
Comment2 to search for | string | Y (One or both of comment1 and comment2 are required) |
Comment2 |
Comment2 to search for | string |
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS |
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS |
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
AccountNumberRefSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
transaction_id |
Transaction ID to search for | string | Y | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Order ID |
string | Only if CyberCash merchant |
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
PurchaseOrderSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
purchase_order_num |
Purchase Order Number to search for | string | Y | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
RecurringBillingProfileIDSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
profile_id |
Profile ID to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Profile ID |
string | |
Profile Name |
string | |
Name |
string | |
Address |
string | |
Phone Number |
string | |
Email |
string | |
Recurring Amount |
currency | |
Original Start Date |
date | |
Term |
number | |
Frequency |
string | |
Status |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Comment |
string | |
Start Date |
date | |
Next Payment Date |
date | |
Last Date |
date | |
Date Established |
date |
RecurringBillingProfileNameSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
profile_name |
Profile Name to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Profile Name |
string | |
Profile ID |
string | |
Status |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Frequency |
string | |
Start Date |
date | |
Date Established |
date |
RecurringBillingAccountNumberSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
account_number |
Account number to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Profile Name |
string | |
Profile ID |
string | |
Status |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Frequency |
string | |
Start Date |
date | |
Date Established |
date |
RecurringBillingCommentSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
comment |
Comment to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Profile Name |
string | |
Profile ID |
string | |
Status |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Frequency |
string | |
Start Date |
date | |
Date Established |
date |
RecurringBillingAmountSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
amount |
Amount to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Profile Name |
string | |
Profile ID |
string | |
Status |
string | |
Account Number |
string | Only the last 4 digits are returned |
Expires |
string | |
Amount |
currency | |
Frequency |
string | |
Start Date |
date | |
Date Established |
date |
FraudTransactionSearch
Important: Run a Fraud Protection Report to get the fraud transaction ID before running this search.
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
fraud_transaction_id |
transaction ID to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Transaction ID |
string | |
Time |
string | |
Return Code Message |
string | |
Customer Name |
string | |
Email Address |
string | |
Phone Number |
string | |
Amount |
currency | |
Total Items |
number | |
SKU |
string | |
Account Number |
string | Only the last 4 digits are returned |
AVS Street Match |
string | |
AVS Zip Match |
string | |
CSC Match |
string | |
International AVS Indicator |
string | |
Buyer Authentication |
string | |
Billing Name |
string | |
Billing Street1 |
string | |
Billing Street2 |
string | |
Billing City |
string | |
Billing State |
string | |
Billing Zip |
string | |
Billing Country |
string | |
Shipping Name |
string | |
Shipping Street1 |
string | |
Shipping Street2 |
string | |
Shipping City |
string | |
Shipping State |
string | |
Shipping Zip |
string | |
Shipping Country |
string | |
Client IP Address |
string | |
Num Custom Rules |
number | |
Custom Rules |
string | |
Num Triggered Rules |
number | |
Triggered Rules |
string | |
Num Unprocessed Rules |
number | |
Unprocessed Rules |
string |
OrderIDSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
order_id |
Order ID to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
Order ID |
string | |
Transaction ID |
string | |
Merchant |
string | |
Time |
string | |
Type |
string | |
Duration |
number | |
Tender Type |
string | |
Client IP Address |
string | |
Account Number |
string | Only the last 4 digits are returned |
Client Version |
string | |
Expires |
string | |
Street |
string | |
Amount |
currency | |
Zip |
string | |
Email |
string | |
Name On Card |
string | |
Comment1 |
string | |
Comment2 |
string | |
Result Code |
number | |
Response Msg |
string | |
Authcode |
string | |
Original Transaction ID |
string | |
AVS Street Match |
string | |
Original Amount |
currency | |
AVS Zip Match |
string | |
Batch ID |
number | |
AVS Result Code |
string |
PayPalTransactionIDSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
paypal_transaction_id |
PayPal transaction ID to search for | string | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
| PayPal Transaction ID | string | Unique transaction ID of the payment returned in a DoExpressCheckoutPayment response |
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Email |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
PayPalEmailSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
email |
Email address to search for | string | Y | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
PayPal Transaction ID |
string | |
Transaction ID |
string | |
Time |
string | |
Type |
string | |
Tender Type |
string | |
Email |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |
PayPalNameSearch
Input parameters
| Name | Description | Type | Required? | Allowed values | Default value | Auto-computed by scheduler? |
|---|---|---|---|---|---|---|
last_name |
Last name to search for | string | Y | |||
first_name |
First name to search for | string | N | |||
start_date |
Start date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
end_date |
End date to search for | datetime - YYYY-MM-DD HH:MI:SS | Y | |||
timezone |
Timezone used to interpret times | string | N | GMT GMT ± XX:XX |
GMT | N |
Output parameters
| Column name | Type | Comment |
|---|---|---|
PayPal Transaction ID |
string | Unique transaction ID of the payment returned in a DoExpressCheckoutPayment response |
Transaction ID |
string | |
\1 |
string | |
Type |
string | |
Tender Type |
string | |
Email |
string | |
Amount |
currency | |
Response Msg |
string | |
Comment1 |
string | |
Comment2 |
string |