---
title: "Obter lista de cobraças"
method: GET
path: "/companies/{companyId}/pix-cash-in/instant-collections"
tags: ["Pix Cobrança"]
---

# Obter lista de cobraças

`GET /companies/{companyId}/pix-cash-in/instant-collections`

## Path parameters

- `companyId` string, required — CNPJ da empresa

## Query parameters

- `locationId` string
- `initialDate` string — Data inicial para a listagem
- `finalDate` string — Data final para a listagem
- `onlyActive` string — Mostrar apenas as cobranças ativas. Não aceita o valor como false

## Response `200`

Instant Collections

- GetInstantCollectionsResponse
  - `data` InstantCollection[]
    - `id` string
    - `txId` string
    - `taxId` string
    - `status` string
    - `displayText` string
    - `pixKey` string
    - `paymentInfo` object
      - `endToEndId` string
      - `paymentDate` string
      - `paidAmount` number
    - `amount` object
      - `value` number
      - `allowCustomerChangeValue` boolean
    - `location` object
      - `id` string
      - `type` string
      - `taxId` string
      - `url` string
      - `description` string
      - `path` string
      - `integrationUrl` string

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)