# 查询交易汇总 (/zh/docs/pix-processamento/endpoints/reports/get_user_summary)

## GET /user/summary

`GET https://api.payzu.processamento.com/v1/user/summary`

Aggregated totals for deposits, withdrawals and commission over a period.

Guia: Reconciliation (/docs/pix-processamento/tutoriais/reconciliation)

### Query params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `dateFrom` | string | no | Start date. — format: date-time |
| `dateTo` | string | no | End date. — format: date-time |
| `groupBy` | string | no | Grouping applied to the transactions. — `day`, `hour`; default: day |
| `grouped` | boolean | no | When true, returns a series grouped by date. |

### Responses

**200** Summary.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `totalTransactions` | integer | no | Number of transactions in the period. |
| `deposit` | object | no |  |
| `deposit.totalAmount` | number | no | Sum of the amounts in the period. |
| `deposit.totalTransactions` | integer | no | Number of transactions of that type in the period, also summing all statuses. |
| `deposit.statuses` | object | no | Totals by status in the period. |
| `deposit.statuses.pending` | object | no |  |
| `deposit.statuses.completed` | object | no |  |
| `deposit.statuses.canceled` | object | no |  |
| `deposit.statuses.expired` | object | no |  |
| `deposit.statuses.refunded` | object | no |  |
| `deposit.grouped` | object[] | no | Present only when grouped=true. |
| `deposit.grouped.date` | string | no | Start of the interval, truncated by day or by hour according to groupBy. |
| `deposit.grouped.amount` | number | no | Sum of the amounts, in reais, of the transactions in the interval. |
| `withdraw` | object | no |  |
| `withdraw.totalAmount` | number | no | Sum of the amounts in the period. |
| `withdraw.totalTransactions` | integer | no | Number of transactions of that type in the period, also summing all statuses. |
| `withdraw.statuses` | object | no | Totals by status in the period. |
| `withdraw.statuses.pending` | object | no |  |
| `withdraw.statuses.completed` | object | no |  |
| `withdraw.statuses.canceled` | object | no |  |
| `withdraw.statuses.expired` | object | no |  |
| `withdraw.statuses.refunded` | object | no |  |
| `withdraw.grouped` | object[] | no | Present only when grouped=true. |
| `withdraw.grouped.date` | string | no | Start of the interval, truncated by day or by hour according to groupBy. |
| `withdraw.grouped.amount` | number | no | Sum of the amounts, in reais, of the transactions in the interval. |
| `commission` | object | no |  |
| `commission.totalAmount` | number | no | Sum of the amounts in the period. |
| `commission.totalTransactions` | integer | no | Number of transactions of that type in the period, also summing all statuses. |
| `commission.statuses` | object | no | Totals by status in the period. |
| `commission.statuses.pending` | object | no |  |
| `commission.statuses.completed` | object | no |  |
| `commission.statuses.canceled` | object | no |  |
| `commission.statuses.expired` | object | no |  |
| `commission.statuses.refunded` | object | no |  |
| `commission.grouped` | object[] | no | Present only when grouped=true. |
| `commission.grouped.date` | string | no | Start of the interval, truncated by day or by hour according to groupBy. |
| `commission.grouped.amount` | number | no | Sum of the amounts, in reais, of the transactions in the interval. |

**400** Invalid request

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `status` | string | yes | Fixed marker of an error response. |
| `error` | string | yes | Name of the corresponding HTTP status. |
| `errorCode` | string | yes | Stable machine-readable error code, when available. |
| `message` | string | yes | Human-readable error message. |
| `statusCode` | integer | yes | HTTP status code. |
| `requestId` | string | yes | Unique request correlation ID (cuid). Include it when contacting support. |
| `details` | object[] | no | Field-level validation errors, when applicable. |
| `details.field` | string | yes | Path of the field rejected in validation, without the leading slash. |
| `details.message` | string | yes | Reason that field was rejected, in Portuguese. |
| `retryAfterSeconds` | integer | no | Seconds to wait before retrying. Present only on 429 responses. |

**401** Authentication failure

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `status` | string | yes | Fixed marker of an error response. |
| `error` | string | yes | Name of the corresponding HTTP status. |
| `errorCode` | string | yes | Stable machine-readable error code, when available. |
| `message` | string | yes | Human-readable error message. |
| `statusCode` | integer | yes | HTTP status code. |
| `requestId` | string | yes | Unique request correlation ID (cuid). Include it when contacting support. |
| `details` | object[] | no | Field-level validation errors, when applicable. |
| `details.field` | string | yes | Path of the field rejected in validation, without the leading slash. |
| `details.message` | string | yes | Reason that field was rejected, in Portuguese. |
| `retryAfterSeconds` | integer | no | Seconds to wait before retrying. Present only on 429 responses. |