# Summarize Cash-Outs

Aggregated Cash-Out figures for a period: totals per status, and the same figures broken
down by settlement bank.

## Status buckets

The keys are the Cash-Out status values returned by GET /cash-out/{id}, the listing and the
webhooks, in lowercase.

| Key | Status | Meaning |
|---|---|---|
| processing | PROCESSING | Being executed at the financial institution |
| pending | PENDING | Held on the ConnectPSP side (approval, analysis or reconciliation) |
| completed | COMPLETED | Settled |
| cancelled | CANCELLED | The money never left your account |
| refunded | REFUNDED | Settled, then returned to your account |

A bucket only appears when it has at least one transaction.

## Settlement breakdown

settlement counts and sums completed transactions only.

Endpoint: GET /cash-out/summary
Version: 2.2.0
Security: bearerAuth

## Header parameters:

  - `ApplicationToken` (string, required)
    Fixed GUID that uniquely identifies your integration. Provided during ConnectPSP onboarding.
    Example: "{{ApplicationToken}}"

## Query parameters:

  - `from` (string, required)
    Start of the period, inclusive. Accepts a plain date (YYYY-MM-DD) or a full ISO 8601
timestamp (YYYY-MM-DDTHH:mm:ss).

Times without an explicit offset are read as America/Sao_Paulo (UTC-3). A plain date
becomes 00:00:00.000 of that day in that timezone.

The period filters on when the transaction was created, not when it was paid.
    Example: "2026-08-01"

  - `to` (string, required)
    End of the period, inclusive. Same format rules as from. A plain date becomes
23:59:59.999 of that day in America/Sao_Paulo.
    Example: "2026-08-01"

## Response 200 fields (application/json):

  - `from` (string)
    Start of the period, echoed back in America/Sao_Paulo.
    Example: "2026-08-01T00:00:00-03:00"

  - `to` (string)
    Example: "2026-08-01T23:59:59-03:00"

  - `currency` (string)
    Example: "BRL"

  - `totals` (object)
    Status key → {count, amount}. Only statuses with at least one transaction appear.

Cash-In keys: pending, paid, refunded.
Cash-Out keys: the Cash-Out statuses in lowercase — processing, pending, completed,
cancelled, refunded.

  - `settlement` (array)
    Breakdown by settlement bank, paid transactions only (paid on Cash-In, completed on
Cash-Out), ordered by amount descending.

  - `settlement.ispb` (string)
    Example: "12345678"

  - `settlement.bank` (string)
    Example: "SETTLEMENT PARTNER A"

  - `settlement.count` (integer)
    Example: 1103

  - `settlement.amount` (number)
    Example: 165230.75

## Response 401 fields (application/problem+json):

  - `type` (string)
    URI identifying the error type. It can contain non-ASCII characters.
    Example: "https://doc.connectpsp.com/errors/duplicated-external-reference"

  - `title` (string)
    Short, human-readable summary.
    Example: "Referência Externa Duplicada"

  - `status` (integer)
    HTTP status code.
    Example: 409

  - `code` (string)
    Machine-readable error code for programmatic handling. Absent on the 401 for a missing or
invalid ApplicationToken.
    Example: "DUPLICATED_EXTERNAL_REFERENCE"

  - `detail` (string)
    Human-readable explanation of this specific occurrence.
    Example: "Já existe uma operação com o externalReference informado: withdraw_xyz789."

  - `errors` (object)
    Only on VALIDATION_ERROR. Field name → list of validation messages for that field.

  - `instance` (string)
    Request path where the error occurred. Present on some errors, such as INTERNAL_ERROR.

  - `traceId` (string)
    Only on INTERNAL_ERROR. Send it to support to locate the occurrence.

## Response 422 fields (application/problem+json):

  - `type` (string)
    URI identifying the error type. It can contain non-ASCII characters.
    Example: "https://doc.connectpsp.com/errors/duplicated-external-reference"

  - `title` (string)
    Short, human-readable summary.
    Example: "Referência Externa Duplicada"

  - `status` (integer)
    HTTP status code.
    Example: 409

  - `code` (string)
    Machine-readable error code for programmatic handling. Absent on the 401 for a missing or
invalid ApplicationToken.
    Example: "DUPLICATED_EXTERNAL_REFERENCE"

  - `detail` (string)
    Human-readable explanation of this specific occurrence.
    Example: "Já existe uma operação com o externalReference informado: withdraw_xyz789."

  - `errors` (object)
    Only on VALIDATION_ERROR. Field name → list of validation messages for that field.

  - `instance` (string)
    Request path where the error occurred. Present on some errors, such as INTERNAL_ERROR.

  - `traceId` (string)
    Only on INTERNAL_ERROR. Send it to support to locate the occurrence.