---
title: "Listar liquidações completas"
method: GET
path: "/v1/marketplace/liquidations"
tags: ["Liquidações"]
---

# Listar liquidações completas

`GET /v1/marketplace/liquidations`

## Query parameters

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

## Headers

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

## Response `200`

- object
  - `total` number, required — Número total de registros.
  - `page` number, required — Página atual.
  - `perPage` number, required — Número de registros por página.
  - `lastPage` number, required — Número total de páginas.
  - `data` LiquidationMarketplaceResponse[]
    - `_id` string, required — ID da liquidação.
    - `amount` number, required — Valor total da liquidação, em centavos.
    - `transactions` number, required — Quantidade de transações associadas à liquidação.
    - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'ERROR', required — Status atual da liquidação.
    - `liquidation` string, date-time, required — Data em que a liquidação foi realizada.
    - `establishment` EstablishmentInfo, required
      - `id` number, required — ID do estabelecimento.
      - `name1` string, required — Nome ou razão social do estabelecimento.
      - `name2` string, nullable, required — Nome fantasia ou nome complementar do estabelecimento.
      - `document` string, required — Documento do estabelecimento.
      - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'ERROR', required — Status atual do estabelecimento.
      - `active` boolean, required — Indica se o estabelecimento está ativo.
      - `block` number, required — Define se o estabelecimento está bloqueado.
      - `type` string, required — Tipo do estabelecimento.
    - `marketplace` MarketplaceInfo, required
      - `id` number, required — ID do marketplace.
      - `name1` string, required — Nome ou razão social principal do marketplace.
      - `name2` string, required — Nome fantasia ou nome complementar do marketplace.
      - `document` string, required — Documento do marketplace.
      - `nickname` string, required — Apelido do marketplace.
    - `plans` Plan[], required — Lista de planos envolvidos na liquidação.
      - `id` number, required — ID do plano.
      - `name` string, required — Nome do plano.
      - `allow_anticipation` boolean, required — Define se o plano permite antecipação.
      - `modality` 'ONLINE' | 'PHYSICAL', required — Modalidade do plano.
      - `pivot` PlanPivot, required
        - `plan_id` number, required — ID do plano vinculado.
        - `establishment_id` number, required — ID do estabelecimento vinculado.
        - `active` boolean, required — Define se o vínculo do plano com o estabelecimento está ativo.
    - `payments` Payment[], required — Lista de pagamentos realizados durante a liquidação.
      - `_id` string, required — ID do pagamento.
      - `amount` number, required — Valor líquido do pagamento, em centavos.
      - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'ERROR', required — Status atual do pagamento.
      - `original_amount` number, required — Valor original antes de descontos ou reduções.
      - `transfer_id` string, required — ID da transferência associada a este pagamento.
      - `send_to_establishment` boolean, required — Indica se o valor será enviado ao estabelecimento.
      - `receipt` Receipt, required
        - `document` string, required — Documento do titular da conta.
        - `form_receipt` 'BANKACCOUNT' | 'PAYTIME' | 'PAGBANK' | 'ZOOPBANK', required — Forma de recebimento.
        - `type` string, required — Tipo de conta.
        - `routing_number` string, required — Número da agência.
        - `account_check_digit` string, required — Dígito verificador da conta bancária.
        - `routing_check_digit` string, required — Dígito verificador da agência.
        - `account_number` string, required — Número da conta bancária.
        - `bank` Bank, required
          - `id` number, required — ID do banco.
          - `name` string, required — Nome do banco.
          - `code` string, required — Código do banco.
          - `ispb` string, required — Código ISPB do banco.
      - `effects` object[], required — Lista de efeitos aplicados ao pagamento.
      - `reductions` Reduction[], required — Lista de reduções aplicadas ao valor original do pagamento.
        - `amount` number, required — Valor reduzido do pagamento, em centavos.
        - `motive` string, required — Motivo da redução aplicada ao pagamento.
        - `description` string, required — Descrição adicional sobre a redução aplicada.
        - `file_url` string, required — URL do arquivo que comprova ou justifica a redução.
        - `status` 'CREATED' | 'DELETED', required — Status atual da redução aplicada.
        - `history` ReductionHistory[], required — Histórico de alterações do status da redução.
          - `status` 'CREATED' | 'DELETED', required
          - `user_id` number, required
          - `created_at` string, date-time, required
        - `created_at` string, date-time, required — Data de criação da redução.
    - `reprocessing` boolean, required — Indica se a liquidação está em processo de reprocessamento.
    - `history` History[], required — Histórico de mudanças de status da liquidação.
      - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'ERROR', required
      - `created_at` string, date-time, required
      - `user` HistoryUser, required
        - `id` number, required — ID do usuário que realizou a ação.
        - `first_name` string, required — Primeiro nome do usuário.
        - `last_name` string, required — Último nome do usuário.
    - `created_at` string, date-time, required — Data de criação do registro da liquidação.
    - `updated_at` string, date-time, required — Data da última atualização do registro da liquidação.

---

[API](https://skmtc.net/paytime/apis/api-p-blica.md) · [All operations](https://skmtc.net/paytime/apis/api-p-blica/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paytime/api-p-blica/revisions/5c818991d183/schema)