---
title: "Listar pagamentos"
method: GET
path: "/v1/marketplace/payments"
tags: ["Pagamentos de boletos"]
---

# Listar pagamentos

`GET /v1/marketplace/payments`

## 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` PaymentMarketplaceResponse[]
    - `_id` string, required — ID do pagamento.
    - `status` 'PAID' | 'PENDING' | 'PROCESSING' | 'REFUNDED' | 'CANCELED', required — Status atual do pagamento.
    - `expected_on` string, date-time, required — Data prevista para o pagamento.
    - `amount` number, required — Valor do pagamento.
    - `payment_details` PaymentDetails, required
      - `balance` number, required — Valor pago com saldo.
      - `card` number, required — Valor pago com cartão.
      - `total` number, required — Valor total pago.
      - `fees` number, required — Valor da taxa aplicada quando pago com cartão.
    - `establishment` EstablishmentPaymentInfo, required
      - `id` number, required — ID do estabelecimento.
      - `type` 'INDIVIDUAL' | 'BUSINESS', required — Tipo do estabelecimento.
      - `access_type` string, required — Tipo de acesso do estabelecimento.
      - `active` number, required — Indica se o estabelecimento está ativo.
      - `first_name` string, required — Nome / Razão social.
      - `last_name` string, required — Sobrenome / Nome fantasia.
      - `document` string, required — CPF / CNPJ.
    - `marketplace` MarketplacePaymentInfo, required
      - `id` number, required — ID do marketplace.
      - `type` 'WHITELABEL' | 'LICENSED' | 'REPRESENTATIVE', required — Tipo do marketplace.
      - `nickname` string, required — Apelido do marketplace.
      - `active` number, required — Indica se o marketplace está ativo.
      - `first_name` string, required — Nome / Razão social.
      - `last_name` string, required — Sobrenome / Nome fantasia.
      - `document` string, required — CPF / CNPJ.
    - `created_at` string, date-time, required — Data e hora da criação do pagamento.
    - `payment_date` string, date-time, required — Data e hora em que o pagamento foi efetivado.

---

[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)