| BeginDate | model | string | Yes | Beginning date of the transaction record query. |
| EndDate | model | string | No | End date of the transaction record query. |
| TransactionType | model | List<TransactionType> | No | If provided, only those transactions matching the TransactionTypes will be included.Allowable Values- Authorization
- Sale
- Return
- Void
- Force
- Capture
- CaptureAll
- RepeatSale
- Adjustment
- Activate
- Deactivate
- Redeem
- Inquire
- Reload
|
| InvoiceNumber | model | string | No | The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included. |
| SettlementFlag | model | SettlementFlag? | No | The SettlementFlag parameter allows you to choose whether settled or unsettled transactions are included in the results.Allowable Values |
| SettleBeginDate | model | string | No | Beginning date of the settlement search window. |
| SettleEndDate | model | string | No | End date of the settlement search window. |
| SettleMessage | model | string | No | The settlement ID or message returned from the host. |
| SettleStatus | model | SettleStatus? | No | Allows you to choose whether settled or unsettled transactions are included in the results. |
| Username | model | string | No | The user who originated the transactions. If provided, only those transactions created by the matching User will be included. |
| ResultCode | model | List<string> | No | If provided, only those transactions matching the Result will be included. |
| Register | model | string | No | The register (if applicable) on which the transaction was processed |
| ApprovalCode | model | string | No | The approval code is a alphanumeric value generated by the issuing bank. This field may also be used by payment processors to return error messages.
Note: Approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned. |
| NameOnInstrument | model | string | No | For card transactions, this is the name on the card. For check transactions, this is the name on the check. If provided, only those transactions with a matching instrument name will be included. |
| CustomerId | model | string | No | Merchant-assigned identifier of the customer associated with the transaction(s) |
| ContractId | model | string | No | Merchant-assigned identifier of the contract associated with the transaction(s) |
| ContractKey | model | int? | No | System-assigned identifier of the contract associated with the transaction(s) |
| SortField | model | string | No | The field name by which the records will be sorted. Default is 'BeginDate'.Allowable Values- PnRef
- InvoiceNumber
- TransactionTimestamp
- AuthorizationTimestamp
- MerchantKey
- ResellerKey
- PaymentType
- TransactionType
- Processor
|
| CustomFields | model | CustomField[] | No | Custom field value(s) used to filter query results |
| TotalAmountMax | model | decimal? | No | Specifies the maximum amount value of the transactions being searched for. In DDDDDD.CC format |
| TotalAmountMin | model | decimal? | No | Specifies the minimum amount value of the transactions being searched for. In DDDDDD.CC format |
| PaymentType | model | List<PaymentType> | No | If provided, only those transactions matching the Payment Type will be included.Allowable Values- VISA
- DINERS
- AMEX
- MASTERCARD
- JAL
- JCB
- DISCOVER
- CARTEBLANCHE
- EBT
- LOYALTY
- DEBIT
- ECG
- CASH
- VERIFY
- ECHECK
|
| CardNumber | model | string | No | If provided, only those transactions with an exact Card Number match will be included. |
| CheckType | model | List<CheckType> | No | If provided, only those transactions matching the Check Type will be included.Allowable Values |
| CheckAccountType | model | List<CheckAccountType> | No | If provided, only those transactions matching the Check Account Type will be included.Allowable Values |
| CheckAccountNumber | model | int? | No | If provided, only those transactions with an exact Check Account Number match will be included. |
| CheckRoutingNumber | model | int? | No | If provided, only those transactions with an exact Check Routing Number match will be included. |