---
title: "Lista extrato do estabelecimento"
method: GET
path: "/v1/marketplace/establishments/extract"
tags: ["Estabelecimentos"]
---

# Lista extrato do estabelecimento

`GET /v1/marketplace/establishments/extract`

## Request

- Base URL: `https://api.sandbox.paytime.com.br`
- URL: `https://api.sandbox.paytime.com.br/v1/marketplace/establishments/extract`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/paytime/apis/api-p-blica/docs/v1/marketplace/establishments/extract/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `filters` string
- `search` string
- `perPage` number
- `page` number
- `sorters` string

## Headers

- `integration-key` string, required
- `x-token` string, required
- `establishment_id` string, required

## Response `200`

- EstablishmentExtractPaginatedResponse
  - `total` number, required: Total de registros.
  - `perPage` number, required: Registros por página.
  - `page` number, required: Página atual.
  - `lastPage` number, required: Última página.
  - `data` EstablishmentExtractResponse[], required: Dados do extrato.
    - `type` 'FEES' | 'PIX' | 'TED' | 'BILLET' | 'P2P', required: Tipo da transferência.
    - `modality` 'OUT' | 'IN', required: Modalidade da transferência.
    - `created_at` string, required: Data de criação da transferência.
    - `description` 'PAGAMENTO DE CONTAS' | 'RECEBIMENTO DE PAGAMENTO' | 'TRANSFERÊNCIA PIX' | 'RECEBIMENTO PIX' | 'DEPOSITO' | 'TRANSFERÊNCIA ENVIADA' | 'TRANSFERÊNCIA RECEBIDA' | 'TRANSFERÊNCIA ENTRE CONTAS (P2P)', required: Descrição da transferência.
    - `gateway_key` string, required: Chave identificadora da transferência no gateway.
    - `amount` number, required: Valor da transferência em centavos.
    - `status` string, required: Status da transferência.
    - `additionalInformation` AdditionalInformationResponse, required
      - `old_balance` number, required: Saldo anterior.
      - `current_balance` number, required: Saldo atual.

---

[API](https://skmtc.dev/paytime/apis/api-p-blica.md) - [All operations](https://skmtc.dev/paytime/apis/api-p-blica/llms.txt) - [OpenAPI document](https://skmtc.dev/paytime/apis/api-p-blica/revisions/5c818991d183?raw)
