# GET /api/transactions/reports/paytype-summary

Rolls up the window's transactions by payment type.

**Required permissions**: `Transactions.Reports.Summary`  
**Scope**: merchant

**Operation ID:** `GET_api_transactions_reports_paytype-summary`

## Authorization

Requires: Transactions.Reports.Summary, merchant scope.

Required permissions:
- `Transactions.Reports.Summary`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| StartDateUtc | query | no | string(date-time) | Start of the reporting window, in UTC. Inclusive: a transaction stamped exactly at this  instant is counted. |
| EndDateUtc | query | no | string(date-time) | End of the reporting window, in UTC. Exclusive: a transaction stamped exactly at this instant  is not counted, so two adjacent windows tile without double-counting the boundary. Must be  later than PhoeniXGate.Transactions.Reports.TransactionSummaryRequestDto.StartDateUtc, and the window may span at most 366 days: a wider  request is rejected with a validation error rather than truncated. |
| MerchantId | query | no | string(uuid) | Optional merchant to restrict the aggregate to. When omitted, the result covers every  merchant the caller is entitled to see. Supplying a merchant outside the caller's scope  yields an empty result rather than an error, because the caller is not entitled to learn  whether that merchant exists. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateTransactionsReportsTransactionSummaryResultDtoOfPhoeniXGateTransactionsReportsPaymentTypeTransactionSummaryDto`

**Content type:** `application/json`

Schema: `PhoeniXGateTransactionsReportsTransactionSummaryResultDtoOfPhoeniXGateTransactionsReportsPaymentTypeTransactionSummaryDto`

**Content type:** `text/json`

Schema: `PhoeniXGateTransactionsReportsTransactionSummaryResultDtoOfPhoeniXGateTransactionsReportsPaymentTypeTransactionSummaryDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.