---
title: "Listar cobranças de um link de pagamento"
method: GET
path: "/{companyId}/banking/payment-link/{paymentLinkId}/collection"
tags: ["Link de pagamento"]
---

# Listar cobranças de um link de pagamento

`GET /{companyId}/banking/payment-link/{paymentLinkId}/collection`

API responsável por listar as cobranças um link de pagamento

## Path parameters

- `paymentLinkId` string, required — Identificador do Link de Pagamento
- `companyId` string, required

## Query parameters

- `pageSize` integer, required — Quantidade de cobranças por página
- `pageNumber` integer, required — Número da página
- `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
- `type` 'IMMEDIATE_QRCODE' | 'BANKSLIP' | 'CREDIT_CARD' — Tipo da cobrança
- `minCreatedAt` string — Data
- `maxCreatedAt` string — Data
- `payer.name` string — Nome do pagador
- `payer.taxId` string — Documento do pagador

## Response `200`

Sucesso

- ListPaymentLinkCollectionsResponse
  - `data` object[]
    - `amount` number — Valor
    - `collectionId` string — Id da cobrança
    - `createdAt` string — Data
    - `description` string
    - `dueDate` string — Data
    - `paidAt` string — Data
    - `payee` object
      - `name` string — Nome do beneficiário
      - `email` string — Email do beneficiário
      - `personType` string
      - `phoneNumber` string — Telefone do beneficiário
      - `taxId` string — Documento do pagador
    - `payer` object
      - `name` string — Nome do pagador
      - `email` string — Email do beneficiário
      - `personType` string
      - `phoneNumber` string — Telefone do beneficiário
      - `taxId` string
    - `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
    - `type` 'IMMEDIATE_QRCODE' | 'BANKSLIP' | 'CREDIT_CARD' — Tipo da cobrança
    - `updatedAt` string — Data
    - `detail` object
      - `emv` string
      - `pixKey` string
      - `txId` string
  - `cursor` Cursor
    - `previous` object
      - `href` string
      - `method` string
      - `type` string
    - `next` object
      - `href` string
      - `method` string
      - `type` string

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

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