# Consultar resumo de transações (/docs/pix-processamento/endpoints/reports/get_user_summary)

## GET /user/summary

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

Totais agregados de depósitos, saques e comissão num período.

Guia: Conciliação (/docs/pix-processamento/tutoriais/reconciliation)

### Query params

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `dateFrom` | string | no | Data inicial. Padrão: início do dia anterior (America/Sao_Paulo). — format: date-time |
| `dateTo` | string | no | Data final. Padrão: agora. — format: date-time |
| `groupBy` | string | no | Agrupamento das transações. — `day`; default: day |
| `grouped` | boolean | no | Quando true, retorna uma série agrupada por data. |

### Responses

**200** Resumo.

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `totalTransactions` | integer | no | Quantidade de transações no período. |
| `deposit` | object | no |  |
| `deposit.totalAmount` | number | no | Soma dos valores no período. |
| `deposit.totalTransactions` | integer | no | Quantidade de transações desse tipo no período, também somando todos os status. |
| `deposit.statuses` | object | no | Totais por status no período. |
| `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 | Presente apenas quando grouped=true. |
| `deposit.grouped.date` | string | no | Dia (YYYY-MM-DD, fuso America/Sao_Paulo). |
| `deposit.grouped.amount` | number | no | Soma dos valores, em reais, das transações concluídas no dia. |
| `withdraw` | object | no |  |
| `withdraw.totalAmount` | number | no | Soma dos valores no período. |
| `withdraw.totalTransactions` | integer | no | Quantidade de transações desse tipo no período, também somando todos os status. |
| `withdraw.statuses` | object | no | Totais por status no período. |
| `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 | Presente apenas quando grouped=true. |
| `withdraw.grouped.date` | string | no | Dia (YYYY-MM-DD, fuso America/Sao_Paulo). |
| `withdraw.grouped.amount` | number | no | Soma dos valores, em reais, das transações concluídas no dia. |
| `commission` | object | no |  |
| `commission.totalAmount` | number | no | Soma dos valores no período. |
| `commission.totalTransactions` | integer | no | Quantidade de transações desse tipo no período, também somando todos os status. |
| `commission.statuses` | object | no | Totais por status no período. |
| `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 | Presente apenas quando grouped=true. |
| `commission.grouped.date` | string | no | Dia (YYYY-MM-DD, fuso America/Sao_Paulo). |
| `commission.grouped.amount` | number | no | Soma dos valores, em reais, das transações concluídas no dia. |
| `adjustment` | object | no |  |
| `adjustment.totalAmount` | number | no | Soma dos valores no período. |
| `adjustment.totalTransactions` | integer | no | Quantidade de transações desse tipo no período, também somando todos os status. |
| `adjustment.statuses` | object | no | Totais por status no período. |
| `adjustment.statuses.pending` | object | no |  |
| `adjustment.statuses.completed` | object | no |  |
| `adjustment.statuses.canceled` | object | no |  |
| `adjustment.statuses.expired` | object | no |  |
| `adjustment.statuses.refunded` | object | no |  |
| `adjustment.grouped` | object[] | no | Presente apenas quando grouped=true. |
| `adjustment.grouped.date` | string | no | Dia (YYYY-MM-DD, fuso America/Sao_Paulo). |
| `adjustment.grouped.amount` | number | no | Soma dos valores, em reais, das transações concluídas no dia. |

**400** Requisição inválida

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `status` | string | yes | Marcador fixo de resposta de erro. |
| `error` | string | yes | Nome do status HTTP correspondente. |
| `errorCode` | string | yes | Código de erro estável e legível por máquina, quando disponível. |
| `message` | string | yes | Mensagem de erro legível. |
| `statusCode` | integer | yes | Código de status HTTP. |
| `requestId` | string | yes | ID único de correlação da requisição (cuid). |
| `details` | object[] | no | Erros de validação por campo, quando aplicável. |
| `details.field` | string | yes | Caminho do campo rejeitado na validação, sem a barra inicial. |
| `details.message` | string | yes | Motivo da rejeição daquele campo, em português. |
| `retryAfterSeconds` | integer | no | Segundos a aguardar antes de tentar novamente. |

**401** Falha de autenticação

| Field | Type | Required | Details |
| --- | --- | --- | --- |
| `status` | string | yes | Marcador fixo de resposta de erro. |
| `error` | string | yes | Nome do status HTTP correspondente. |
| `errorCode` | string | yes | Código de erro estável e legível por máquina, quando disponível. |
| `message` | string | yes | Mensagem de erro legível. |
| `statusCode` | integer | yes | Código de status HTTP. |
| `requestId` | string | yes | ID único de correlação da requisição (cuid). |
| `details` | object[] | no | Erros de validação por campo, quando aplicável. |
| `details.field` | string | yes | Caminho do campo rejeitado na validação, sem a barra inicial. |
| `details.message` | string | yes | Motivo da rejeição daquele campo, em português. |
| `retryAfterSeconds` | integer | no | Segundos a aguardar antes de tentar novamente. |