# List Cash-Ins

Returns Cash-In transactions created within a period, oldest first by default.
Pass order=desc for newest first.

## Cursor pagination

Send nextCursor from the previous response to fetch the next page. When the response
comes back without nextCursor, you have reached the end of the period.

To walk backwards, send previousCursor in the very same cursor parameter. It is
absent on the first page, so its absence is how you know you are at the start.

Keep from, to, limit and order identical across every page — only cursor changes.
Both directions return the page in the order you asked for.

> ℹ️ There is no total field. Counting the whole window would require a full scan,
> which is exactly what cursor pagination avoids. Every page costs the same, whether it is
> the first or the nine-hundredth.

Each item carries the same fields as GET /cash-in/{id}, minus pixData and
openFinanceData — those only make sense at creation time.

Endpoint: GET /cash-in
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"

  - `limit` (integer)
    Maximum number of items per page. Defaults to 50, maximum 1000.
    Example: 50

  - `cursor` (string)
    Opaque cursor pointing at another page. Copy nextCursor (to go forward) or
previousCursor (to go back) from the previous response verbatim. Do not build or
parse it yourself, its format may change — a cursor already knows which way it goes.

Keep from, to, limit and order identical across every page of the same walk.
    Example: "MTM4OTU0NzI4MDAwMDAwMDB8YXxufFBIUVlST0I"

  - `order` (string)
    Sort direction by date. asc (default) returns the oldest first, desc the newest first.

> ⚠️ order cannot change mid-walk. The direction is baked into the cursor. Sending a
> different order alongside a cursor returns 422 LIST_ORDER_MISMATCH, because the
> next page would otherwise walk backwards — repeating rows you already had and skipping
> rows you never got. To change direction, start a new walk without cursor.
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `items` (array)

  - `items.transactionId` (string)
    Example: "kk6g232xel65a0daee4dd13kk2912714964"

  - `items.internalCode` (string)
    Example: "US7B1JQ"

  - `items.externalReference` (string)
    Example: "order_abc123"

  - `items.endToEndId` (string)
    End-to-end ID issued by BACEN/SPI upon settlement.
- For paid transactions: starts with E (e.g. E00416968...)
- For refunded transactions: starts with D (Devolution)
    Example: "E00416968202603101827cemeFscF6AG"

  - `items.originalEndToEndId` (string)
    The original E2E ID when endToEndId represents a refund.
    Example: "E00416968202603101827cemeFscF6AG"

  - `items.status` (string)
    - AWAITING_PAYMENT — created, not paid yet
- PAID — payment confirmed
- EXPIRED — expired without payment; see expiredAt
- REFUNDED — paid, then returned to the payer; see reason and refundedAt
- CANCELLED — cancelled before being paid; see cancelledAt
    Enum: "AWAITING_PAYMENT", "PAID", "EXPIRED", "REFUNDED", "CANCELLED"

  - `items.reason` (string)
    Why a paid Cash-In went back to the payer. Present only when status is REFUNDED.

- FRAUD, DUPLICATED_PAYMENT, CUSTOMER_REQUEST, MERCHANT_ERROR — the reason you sent on
  POST /cash-in/{id}/refund. FRAUD also covers a MED (Special Return Mechanism) claim, and
  CUSTOMER_REQUEST a devolution the bank flagged as requested by the customer
- PAYER_NOT_ALLOWED — refunded automatically because the payer is not allowed to pay you
- OTHER — any other reason
    Enum: "FRAUD", "DUPLICATED_PAYMENT", "CUSTOMER_REQUEST", "MERCHANT_ERROR", "PAYER_NOT_ALLOWED", "OTHER"

  - `items.amount` (number)
    Example: 150.5

  - `items.payer` (object)

  - `items.payer.name` (string)
    Example: "João Silva"

  - `items.payer.document` (string)
    Example: "12345678909"

  - `items.payer.bankData` (object)
    Banking details returned after settlement. May be null before settlement.

  - `items.payer.bankData.ispb` (string)
    Bank ISPB code (8 digits).
    Example: "00000000"

  - `items.payer.bankData.bank` (string)
    Bank name.
    Example: "Banco do Brasil S.A."

  - `items.payer.bankData.branch` (string)
    Branch number.
    Example: "0001"

  - `items.payer.bankData.account` (string)
    Account number.
    Example: "123456"

  - `items.settlement` (object)
    Present only when money actually moved: PAID and REFUNDED. Absent in
AWAITING_PAYMENT, EXPIRED and CANCELLED — no ConnectPSP account received anything.

  - `items.settlement.ispb` (string)
    ISPB of the settling institution. Key on this, not on bank.
    Example: "12345678"

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

  - `items.settlement.branch` (string)
    Example: "0001"

  - `items.settlement.account` (string)
    Example: "123456"

  - `items.requestedAt` (string)
    When the charge was created. Always present, in every status.
    Example: "2026-03-10T11:20:00-03:00"

  - `items.paidAt` (string)
    Example: "2026-03-10T11:22:15-03:00"

  - `items.refundedAt` (string)
    Example: "2026-03-11T09:00:00-03:00"

  - `items.cancelledAt` (string)
    When the charge was cancelled. Present only on CANCELLED.

  - `items.expiredAt` (string)
    The charge's expiration date and time (the end of the payment window). Same value on GET by id,
on the list and on the CASHIN_EXPIRED webhook. CASHIN_EXPIRED is sent 5 to 7 minutes after
the expiration; the envelope eventAt is the send time, not the expiration.

  - `nextCursor` (string)
    Opaque cursor for the next page. Absent when there are no more pages — that is how
you know the walk is finished.
    Example: "MTM4OTU0NzI4MDAwMDAwMDB8YXxufFVTN0IxSlE"

  - `previousCursor` (string)
    Opaque cursor for the page before this one. Send it in the same cursor parameter.
Absent on the first page — that is how you know you are at the start.
    Example: "MTM4OTU0NzI4MDAwMDAwMDB8YXxwfFVTN0IxSlE"

## 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.