---
title: "Listar iniciação de pagamento ou transferência"
method: GET
path: "/{companyId}/banking/payments"
tags: ["Pagamentos"]
---

# Listar iniciação de pagamento ou transferência

`GET /{companyId}/banking/payments`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/{companyId}/banking/payments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `openid empresas.btgpactual.com/payments.readonly`, `openid empresas.btgpactual.com/payments`

## Path parameters

- `companyId` string, required: CNPJ da empresa

## Query parameters

- `pageSize` number, required
- `pageNumber` number, required
- `paymentType` string
- `receiver` string
- `batchId` string
- `minPaymentDate` string
- `maxPaymentDate` string
- `minAmount` number
- `maxAmount` number
- `status` string

## Response `200`

Lista de Pagamentos

- BankSlipPaymentCollection
  - `data` BankSlipPayment[]
    - `paymentId` string
    - `type` 'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX': Boleto de cobrança
    - `status` 'CONFIRMED' | 'CREATED' | 'CANCELED' | 'FAILED' | 'PROCESSED' | 'ADJOURNED' | 'REVERTED' | 'SCHEDULED': Status do pagamento
    - `amount` number
    - `debitParty` object
      - `taxId` string
      - `name` string
      - `number` string
      - `branchCode` string
      - `bankCode` string
    - `detail` object
      - `digitableLine` string: Linha digitavel
      - `dueDate` string: Data
      - `payee` Payee: Emissor
        - `document` string
        - `fantasyName` string: Nome
        - `socialName` string: Nome
        - `bankCode` string: Código bancário
        - `bankName` string: Nome
    - `tags` object
      - `externalId` string
      - `originTransactionId` string
    - `paymentDate` string, date
  - `_links` object
    - `next` object
      - `href` string
      - `method` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
