| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/statistics/transaction-summaries | BETA VERSION (Subject to change). Gets the transaction summary statistics associated with the authenticated merchant. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeginDate | query | string | No | Beginning date of the statistics query. Defaults to the beginning of the previous day. |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentType | form | string | No | |
| TransactionType | form | string | No | |
| TransactionCount | form | int | No | |
| ApprovedAmount | form | decimal | No | |
| PaymentTypeCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}}