Syntch Gateway API

<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/paytypesummaryGet Payment Type Summary
GetPaymentTypeSummary Parameters:
NameParameterData TypeRequiredDescription
MerchantKeyqueryint?Yes
SearchStartDatequeryDateTimeYes
SearchEndDatequeryDateTimeYes
PaymentTypeSummaryDto Parameters:
NameParameterData TypeRequiredDescription
SummaryReportCcByCardTypeformICollection<SummaryReportCcByPaymentTypeDto>No
CreditformICollection<SummaryReportPayTypeDto>No
CheckformICollection<SummaryReportPayTypeDto>No
DebitformICollection<SummaryReportPayTypeDto>No
EbtformICollection<SummaryReportPayTypeDto>No
LoyaltyformICollection<SummaryReportPayTypeDto>No
GiftformICollection<SummaryReportPayTypeDto>No
SummaryReportCcByPaymentTypeDto Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
SaleCountformint?No
ReturnCountformint?No
SaleAmountformdouble?No
ReturnAmountformdouble?No
TotalAmountformdouble?No
TotalsformSummaryReportCcByPaymentTypeDtoNo
SummaryReportPayTypeDto Parameters:
NameParameterData TypeRequiredDescription
TrxTypeformstringNo
Countformint?No
SettleCountformint?No
AuthAmountformdouble?No
CaptureAmountformdouble?No
TotalAmountformdouble?No
SettleAmountformdouble?No
TipAmountformdouble?No
Level3Amountformdouble?No
TotalsformSummaryReportPayTypeDtoNo

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/transactions/paytypesummary HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentTypeSummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Phoenix.Gate.Integration.Client">
  <Check i:nil="true" />
  <Credit i:nil="true" />
  <Debit i:nil="true" />
  <Ebt i:nil="true" />
  <Gift i:nil="true" />
  <Loyalty i:nil="true" />
  <SummaryReportCcByCardType i:nil="true" />
</PaymentTypeSummaryDto>