Syntch Gateway API

GetTransactionSummaryStatistics

Reporting - Statistics (BETA)

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

The following routes are available for this service:
GET	/reports/statistics/transaction-summaries	BETA VERSION (Subject to change). Gets the transaction summary statistics associated with the authenticated merchant.

**GetTransactionSummaryStatistics** Parameters:
Name	Parameter	Data Type	Required	Description
BeginDate	query	string	No	Beginning date of the statistics query. Defaults to the beginning of the previous day.

**TransactionSummaryStatistics** Parameters:
Name	Parameter	Data Type	Required	Description
TransactionSummaries	model	List<TransactionSummaryStatistic>	No	A list of summary details for this statistic.
SummaryTotals	model	SummaryTotals	No	A summary totals for this statistic.
SummaryTotalsForCards	model	SummaryTotals	No	A summary totals for card payments for this statistic.
SummaryTotalsForChecks	model	SummaryTotals	No	A summary totals for check payments for this statistic.

**TransactionSummaryStatistic** Parameters:
Name	Parameter	Data Type	Required
PaymentType	form	string	No
TransactionType	form	string	No
TransactionCount	form	int	No
ApprovedAmount	form	decimal	No
PaymentTypeCode	form	string	No

**SummaryTotals** Parameters:
Name	Parameter	Data Type	Required
Descriptor	form	string	No
SalesTotal	form	decimal	No
ReturnTotal	form	decimal	No

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

HTTP + JSV

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

GET /reports/statistics/transaction-summaries HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionSummaries: 
	[
		{
			PaymentType: String,
			TransactionType: String,
			TransactionCount: 0,
			ApprovedAmount: 0,
			PaymentTypeCode: String
		}
	],
	SummaryTotals: 
	{
		Descriptor: Summary Totals,
		SalesTotal: 0,
		ReturnTotal: 0
	},
	SummaryTotalsForCards: 
	{
		Descriptor: Summary Totals for Cards,
		SalesTotal: 0,
		ReturnTotal: 0
	},
	SummaryTotalsForChecks: 
	{
		Descriptor: Summary Totals for Checks,
		SalesTotal: 0,
		ReturnTotal: 0
	}
}