| Requires any of the roles: | Reseller, Merchant |
| POST | /reports/transactions/ | Get a list of transactions based on your search criteria. | |
|---|---|---|---|
| GET | /reports/transactions/ | Get a list of transactions based on your search criteria. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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
|
| 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
|
| 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
|
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values
|
| SortField | query | string | No | The field name by which the records will be sorted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
| Void | |
| Settle | |
| SettleAll | |
| Reversal | |
| Refund | |
| Sale | |
| AuthOnly | |
| OfflineAuth | |
| CardVerify | |
| AuthCapture | |
| Adjustment | |
| RepeatSale | |
| BalanceInquire |
| Name | Value | |
|---|---|---|
| Unsettled | 0 | |
| Settled | 1 | |
| All | 99 |
| open | |
| settled | |
| rolledBack |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | model | int? | No | Gateway key for the custom field |
| Name | model | string | No | Name of the custom field as set by the merchant |
| Value | model | string | No | Value (if applicable) to store in the custom field |
| VISA | |
| DINERS | |
| AMEX | |
| MASTERCARD | |
| JAL | |
| JCB | |
| DISCOVER | |
| CARTEBLANCHE | |
| EBT | |
| LOYALTY | |
| DEBIT | |
| ECG | |
| CASH | |
| VERIFY | |
| ECHECK |
| Name | Value | |
|---|---|---|
| Personal | 1 | |
| Business | 2 |
| Name | Value | |
|---|---|---|
| Checking | 1 | |
| Savings | 2 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /reports/transactions/ HTTP/1.1
Host: syntch.simpay.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"BeginDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","TransactionType":["Authorization"],"InvoiceNumber":"String","SettlementFlag":"Unsettled","SettleBeginDate":"0001-01-01T00:00:00.0000000","SettleEndDate":"0001-01-01T00:00:00.0000000","SettleMessage":"String","SettleStatus":"open","Username":"String","ResultCode":["String"],"Register":"String","ApprovalCode":"String","NameOnInstrument":"String","CustomerId":"String","ContractId":"String","ContractKey":0,"SortField":"String","CustomFields":[{"Key":0,"Name":"String","Value":"String"}],"TotalAmountMax":0,"TotalAmountMin":0,"PaymentType":["VISA"],"CardNumber":"String","CheckType":["Personal"],"CheckAccountType":["Checking"],"CheckAccountNumber":0,"CheckRoutingNumber":0,"SortDirection":"String","PageSize":0,"PageNumber":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"PnRef":0,"InvoiceNumber":"String","SequenceNumber":"String","TransactionTimestamp":"0001-01-01T00:00:00.0000000","AuthorizationTimestamp":"0001-01-01T00:00:00.0000000","MerchantKey":0,"UserName":"String","RegisterNumber":"String","ResellerKey":0,"PaymentType":"String","TransactionType":"String","Processor":"String","ProcessorError":"String","SettlementMessage":"String","VoidFlag":"String","SettleFlag":"String","SettlementTimestamp":"0001-01-01T00:00:00.0000000","IP":"String","CustomerId":"String","CustomerKey":0,"CustomerName":"String","OriginalTransactionPnRef":0,"CustomerReference":"String","BatchNumber":"String","BatchSequenceNumber":"String","Adjusted":"String","TransactionFinishTimestamp":"0001-01-01T00:00:00.0000000","ProcessorRequestTimestamp":"0001-01-01T00:00:00.0000000","ProcessorResponseTimestamp":"0001-01-01T00:00:00.0000000","BatchId":"String","ReversalFlag":"String","EntryMode":"String","CardDetail":{"Token":"String","MaskedPAN":"String","NameOnCard":"String","AuthorizationAmount":0,"TipAmount":0,"TotalAmount":0,"CashBackAmount":0,"SurchargeAmount":0,"AccountType":"String","ResultCode":"String","ResultText":"String","ApprovalCode":"String","HostReferenceNumber":"String","AvsResponse":"String","AvsResponseText":"String","CvvResponse":"String","CvvResponseText":"String","Level3Amount":0,"CardExpiration":"String","Street":"String","ZipCode":"String","ThreeDSPaayDetail":{"Status":"String","AcsTransId":"String","AuthValue":"String","CardToken":"String","DsTransId":"String","Eci":"String","ProtocolVersion":"String"}},"CheckDetail":{"Token":"String","CheckNumber":"String","AccountNumber":"String","RoutingNumber":"String","DriversLicenseNumber":"String","SocialSecurityNumber":"String","DateOfBirth":"String","StateCode":"String","NameOnCheck":"String","EmailAddress":"String","PhoneNumber":"String","CheckAmount":0,"ResultCode":"String","ResultText":"String","HostApproval":"String","HostReferenceNumber":"String","ResultMessage":"String","SecondaryResultMessage":"String","TertiaryResultMessage":"String","AccountType":"String","CheckType":"String","SECCode":"String"},"CashDetail":{"CashAmount":0},"InvoiceDetail":{"PurchaseOrderNumber":"String","ShippingAmount":0,"TaxAmount":0,"DutyAmount":0,"ConvenienceAmount":0},"CustomFields":[{"Key":0,"Name":"String","Value":"String"}],"AssociatedTransactions":[{"TransactionId":0,"MerchantKey":0,"Timestamp":"0001-01-01T00:00:00.0000000","PaymentType":"String","TransactionType":"String","Amount":0,"Username":"String","CustomerId":"String","CustomerKey":0,"Payer":"String","Result":"String","SettleFlag":"String"}],"Tags":["String"]}]