| Variable Name | Description(Allowed Values)[Format] |
|---|---|
| username* | Merchant username. |
| password* | Merchant password. |
| condition | A combination of values listed below can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used: Example: condition=pendingsettlement,complete |
| pending: ‘Auth Only’ transactions that are awaiting capture. | |
| pendingsettlement: This transaction is awaiting settlement. | |
| in_progress: This Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to ‘abandoned’ if 24 hours pass with no further action. | |
| abandoned: This Three-Step Redirect API transaction has not been completed, and has timed out. | |
| failed: This transaction has failed. | |
| canceled: This transaction has been voided. | |
| complete: This transaction has settled. | |
| unknown: An unknown error was encountered while processing this transaction. | |
| transaction_type | Retrieves only transactions with the specified transaction type. Use one of the following to specify payment type: |
| cc: A credit card transaction. | |
| ck: A check transaction. | |
| action_type | Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following: Example: action_type=refund,credit |
| sale: Sale transactions. | |
| refund: Refund transactions. | |
| credit: Credit transactions. | |
| auth: ‘Auth Only’ transactions. | |
| capture: Captured transactions. | |
| void: Voided transactions. | |
| check_return: Electronic Check (ACH) transactions that have returned beforesettlement. | |
| check_late_return: Electronic Check (ACH) transactions that have returned aftersettlement. | |
| source | Retrieves only transactions with a particular ‘transaction source’. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following: Example: source=api,recurring |
| api: API transactions. | |
| batch_upload: Batch Upload transactions. | |
| mobile: Mobile (iProcess) transactions. | |
| quickclick: QuickClick transactions. | |
| quickbooks: QuickBooks SyncPay transactions. | |
| recurring: Recurring transactions when using Recurring module. | |
| swipe: SwIPe Software transactions. | |
| virtual_terminal: Virtual Terminal transactions. | |
| internal: Internal transactions. Typically indicates settlement | |
| transaction_id | Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it. |
| subscription_id | Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription’s payment/plan information when used with report_type=recurring. |
| invoice_id | Set a specific Invoice ID. Should only be used when report_type=invoicing. |
| partial_payment_id | Retrieves only transactions with the specified partial payment ID. |
| order_id | Retrieves only transactions with the specified Order ID. |
| first_name | Retrieves only transactions with the specified first name. |
| last_name | Retrieves only transactions with the specified last name. |
| address1 | Retrieves only transactions with the specified specified address. |
| city | Retrieves only transactions with the specified city. |
| state | Retrieves only transactions with the specified state. |
| zip | Retrieves only transactions with the specified zip/postal code. |
| phone | Retrieves only transactions with the specified phone number. |
| fax | Retrieves only transactions with the specified fax number. |
| order_description | Retrieves only transactions with the specified order description. |
| drivers_license_number | Retrieves only transactions with the specified driver’s license number. |
| drivers_license_dob | Retrieves only transactions with the specified driver’s license date of birth. |
| drivers_license_state | Retrieves only transactions with the specified driver’s license state. |
| Retrieves only transactions with the specified billing email address. | |
| cc_number | Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number. |
| merchant_defined_field_# | Retrieves only transactions with the specified merchant defined field value. Replace the ‘#’ with a field number (1-20) (Example: merchant_defined_field_12=value) |
| start_date | Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated. Format: YYYYMMDDhhmmss |
| end_date | Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated. Format: YYYYMMDDhhmmss |
| report_type | Allows customer vault information or a html receipt to be returned. If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable. If you omit the customer_vault_id, the system will return all customers that are stored in the vault. If you include a customer_vault_id, it will return the customer record associated with that ID. Example: report_type=customer_vault&customer_vault_id=123456789 |
| receipt: Will return an html receipt for a specified transaction id. | |
| customer_vault: Set the Query API to return Customer Vault data. | |
| recurring: Set the Query API to return subscription data. | |
| invoicing: Set the Query API to return invoicing data. | |
| gateway_processors: Will return Processor details a user has permissions for. Specify a “user” by querying with that username/password. | |
| account_updater: Will return Customer Vault data that has been updated using the Account Updater service. | |
| test_mode_status: Will return whether the account has test mode active or inactive. | |
| mobile_device_license | Retrieves only transactions processed using the specified mobile device. Example 1: mobile_device_license=D91AC56A-4242-3131-2323-2AE4AA6DB6EB |
| mobile_device_nickname | Retrieves only transactions processed using mobile devices with the specified nickname. Example (URL encoded): mobile_device_nickname=Jim’s%20iPhone |
| customer_vault_id | Set a specific Customer Vault record. Should only be used when report_type=customer_vault. |
| date_search | Allows Customer Vault information to be returned based on the ‘created’ or ‘updated’ date. If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value. If you omit the report_type variable, the system will ignore the date_search variable. Example: |
| created: Will return Customer Vault data created during a specified date range. | |
| updated: Will return Customer Vault data updated during a specified date range. | |
| result_limit | Determines the maximum number of results that may return for the current query. |
| page_number | Determines which “page” of results are returned. For example, “result_limit=100&page_number=0” will return the first 100 results. Using “page_number=1” will return the next 100 results. Default is “0”. |
| result_order | Determines order of in which results are returned. Default value is “standard”. |
| standard: Returns the results from oldest to newest. | |
| reverse: Returns the results from newest to oldest. | |
| invoice_status | |
Specify a comma separated list of what invoice statuses will return when using an “invoicing” report type. Example: invoice_status=open,closed,paid | |
| open: Open Invoices | |
| paid: Paid Invoices | |
| closed: Closed Invoices | |
| past_due: Past Due Invoices |