---
title: "Listar links de pagamentos"
method: GET
path: "/{companyId}/banking/payment-link"
tags: ["Link de pagamento"]
---

# Listar links de pagamentos

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

API responsável por listar os links de pagamento de uma empresa

## Path parameters

- `companyId` string, required

## Query parameters

- `pageSize` integer, required — Quantidade de cobranças por página
- `pageNumber` integer, required — Número da página
- `minCreatedAt` string — Data
- `maxCreatedAt` string — Data
- `minStartAt` string — Data
- `maxStartAt` string — Data
- `minEndAt` string — Data
- `maxEndAt` string — Data
- `minAmount` number — Valor
- `maxAmount` number — Valor
- `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'CANCELED' | 'PAID' — Status do link de pagamento
- `type` 'SINGLE' | 'MULTIPLE' — Tipo do link de pagamento
- `name` string — Nome do link de pagamento

## Response `200`

Sucesso

- ListPaymentLinksResponse
  - `data` PaymentLinkResponse[]
    - `paymentLinkId` string — Identificador do Link de Pagamento
    - `name` string — Nome do link de pagamento
    - `amount` number — Valor
    - `notifications` Notifications
      - `deliveryMediums` string[]
      - `email` string — Email do beneficiário
      - `phone` string — Telefone do beneficiário
    - `paymentMethods` string[] — Métodos de pagamento permitidos
    - `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'CANCELED' | 'PAID' — Status do link de pagamento
    - `createdAt` string — Data
    - `updatedAt` string — Data
    - `schedule` Schedule
      - `startAt` string — Data e hora de ativação do link de pagamento
      - `endAt` string — Data e hora de desativação do link de pagamento
    - `linkUrl` string — URL do link de pagamento
    - `description` string — Descrição do link de pagamento
    - `payer` Payer — Pagador
      - `name` string, required
      - `email` string, email
      - `personType` 'F' | 'J', required
      - `phoneNumber` string
      - `taxId` string, required
      - `address` Address
        - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
        - `zipCode` string
        - `country` string
        - `state` string
        - `city` string
        - `street` string
        - `number` string
        - `complement` string
        - `neighborhood` string
      - `deliveryMediums` string[]
    - `payee` object
      - `name` string — Nome do beneficiário
      - `email` string — Email do beneficiário
      - `personType` string
      - `phoneNumber` string — Telefone do beneficiário
      - `taxId` string
    - `type` 'SINGLE' | 'MULTIPLE' — Tipo do link de pagamento
    - `details` PaymentLinkDetails
      - `limits` object
        - `maxInstallments` integer — Número máximo de parcelas permitidas para pagamento com cartão
  - `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)