Syntch Gateway API

GetTransactionReport

Reporting - Transaction Statistics (BETA)

**Requires Authentication**
Requires any of the roles:	Reseller, Merchant

The following routes are available for this service:
GET	/reports/statistics/transactions/	Get a list of transactions based on your search criteria.

**GetTransactionReport** Parameters:
Name	Parameter	Data Type	Required	Description
SortField	query	string	No	The field name by which the records will be sorted. Default is 'Timestamp'. Allowable Values TransactionId MerchantKey Timestamp PaymentType TransactionType Amount Username Result Payer
BeginDate	query	string	Yes	Beginning date of the transaction record query.
EndDate	query	string	No	End date of the transaction record query.
TransactionId	query	int?	No	Filter by TransactionId.
MerchantKey	query	int?	No	Filter by MerchantKey.
Amount	query	decimal?	No	Filter by Amount.
Username	query	string	No	Filter by Username.
CustomerId	query	string	No	Filter by CustomerId.
Payer	query	string	No	Filter by Payer.
Result	query	List<string>	No	Filter by Result.
TransactionType	query	List<string>	No	Filter by TransactionType.
PaymentType	query	List<string>	No	Filter by PaymentType. Allowable Values CREDIT VISA DINERS AMEX MASTERCARD JAL JCB DISCOVER CARTEBLANCHE EBT DEBIT ECG VERIFY ECHECK
SettleFlag	query	int?	No	Filter by SettleFlag (0 = 'Open', 1 = 'Settled', 2 = 'RolledBack', 5 = 'InProcess', 8 = 'FraudHold'). Allowable Values 0 1 2 5 8

**SortedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
SortDirection	query	string	No	The direction in which the records will be sorted. Default is 'asc'. Allowable Values Asc Desc
SortField	query	string	No	The field name by which the records will be sorted.

**PaginatedRequestDto** Parameters:
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.

**TransactionReport** Parameters:
Name	Parameter	Data Type	Required
TransactionTypeSummary	form	List<TransactionTypeSummary>	No
PaymentSummary	form	List<TransactionPaymentSummary>	No
ResultSummary	form	List<TransactionResultSummary>	No
Transactions	form	List<FilteredTransactionDetail>	No
Pagination	form	PaginationStats	No

**TransactionTypeSummary** Parameters:
Name	Parameter	Data Type	Required
TransactionType	form	string	No
Count	form	int	No
TotalAmount	form	decimal	No

**TransactionPaymentSummary** Parameters:
Name	Parameter	Data Type	Required
PaymentType	form	string	No
Count	form	int	No
TotalAmount	form	decimal	No

**TransactionResultSummary** Parameters:
Name	Parameter	Data Type	Required
Result	form	string	No
Count	form	int	No
TotalAmount	form	decimal	No

**FilteredTransactionDetail** Parameters:
Name	Parameter	Data Type	Required
TransactionId	form	int	No
MerchantKey	form	int	No
Timestamp	form	DateTime	No
PaymentType	form	string	No
TransactionType	form	string	No
Amount	form	decimal	No
Username	form	string	No
CustomerId	form	string	No
CustomerKey	form	int?	No
Payer	form	string	No
Result	form	string	No
SettleFlag	form	string	No

**PaginationStats** Parameters:
Name	Parameter	Data Type	Required
CurrentPageNumber	form	int	No
PageSize	form	int	No
TotalRecordCount	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /reports/statistics/transactions/ HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TransactionReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses.Statistics">
  <Pagination xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
    <d2p1:CurrentPageNumber>0</d2p1:CurrentPageNumber>
    <d2p1:PageSize>0</d2p1:PageSize>
    <d2p1:TotalRecordCount>0</d2p1:TotalRecordCount>
  </Pagination>
  <PaymentSummary>
    <TransactionPaymentSummary>
      <Count>0</Count>
      <PaymentType>String</PaymentType>
      <TotalAmount>0</TotalAmount>
    </TransactionPaymentSummary>
  </PaymentSummary>
  <ResultSummary>
    <TransactionResultSummary>
      <Count>0</Count>
      <Result>String</Result>
      <TotalAmount>0</TotalAmount>
    </TransactionResultSummary>
  </ResultSummary>
  <TransactionTypeSummary>
    <TransactionTypeSummary>
      <Count>0</Count>
      <TotalAmount>0</TotalAmount>
      <TransactionType>String</TransactionType>
    </TransactionTypeSummary>
  </TransactionTypeSummary>
  <Transactions>
    <FilteredTransactionDetail>
      <Amount>0</Amount>
      <CustomerId>String</CustomerId>
      <CustomerKey>0</CustomerKey>
      <MerchantKey>0</MerchantKey>
      <Payer>String</Payer>
      <PaymentType>String</PaymentType>
      <Result>String</Result>
      <SettleFlag>String</SettleFlag>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TransactionId>0</TransactionId>
      <TransactionType>String</TransactionType>
      <Username>String</Username>
    </FilteredTransactionDetail>
  </Transactions>
</TransactionReport>

Syntch Gateway API

GetTransactionReport

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML