Rolls up the window's transactions by payment type.
GET
/api/transactions/reports/paytype-summary
deprecated
Requires: Transactions.Reports.Summary, merchant scope.
**Required permissions**: `Transactions.Reports.Summary` **Scope**: merchant
Parameters
| Name | In | Type | Description |
|---|---|---|---|
StartDateUtc
required |
query | string (date-time) | Start of the reporting window, in UTC. Inclusive: a transaction stamped exactly at this instant is counted. |
EndDateUtc
required |
query | 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
required |
query | 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
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.