<back to all web services
GetPaymentTypeSummary
Reporting - Summaries
Requires Authentication
| Requires any of the roles: | Reseller, Merchant, Merchant |
The following routes are available for this service:| GET | /reports/transactions/paytypesummary | Get Payment Type Summary | |
|---|
GetPaymentTypeSummary Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| MerchantKey | query | int? | Yes | |
| SearchStartDate | query | DateTime | Yes | |
| SearchEndDate | query | DateTime | Yes | |
PaymentTypeSummaryDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SummaryReportCcByCardType | form | ICollection<SummaryReportCcByPaymentTypeDto> | No | |
| Credit | form | ICollection<SummaryReportPayTypeDto> | No | |
| Check | form | ICollection<SummaryReportPayTypeDto> | No | |
| Debit | form | ICollection<SummaryReportPayTypeDto> | No | |
| Ebt | form | ICollection<SummaryReportPayTypeDto> | No | |
| Loyalty | form | ICollection<SummaryReportPayTypeDto> | No | |
| Gift | form | ICollection<SummaryReportPayTypeDto> | No | |
SummaryReportCcByPaymentTypeDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| PaymentType | form | string | No | |
| SaleCount | form | int? | No | |
| ReturnCount | form | int? | No | |
| SaleAmount | form | double? | No | |
| ReturnAmount | form | double? | No | |
| TotalAmount | form | double? | No | |
| Totals | form | SummaryReportCcByPaymentTypeDto | No | |
SummaryReportPayTypeDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| TrxType | form | string | No | |
| Count | form | int? | No | |
| SettleCount | form | int? | No | |
| AuthAmount | form | double? | No | |
| CaptureAmount | form | double? | No | |
| TotalAmount | form | double? | No | |
| SettleAmount | form | double? | No | |
| TipAmount | form | double? | No | |
| Level3Amount | form | double? | No | |
| Totals | form | SummaryReportPayTypeDto | 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/transactions/paytypesummary HTTP/1.1
Host: syntch.simpay.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}