---
title: "Buscar cobrança"
method: GET
path: "/collections/{collectionId}"
tags: ["Collection"]
---

# Buscar cobrança

`GET /collections/{collectionId}`

API responsável por buscar uma cobrança. Pode retornar os dados em json ou PDF.

## Path parameters

- `collectionId` string, required — Id da cobrança

## Headers

- `Accept` 'application/json' | 'application/pdf', required — Tipo de retorno

## Response `200`

Buscar cobrança

- CollectionResponse
  - `collectionId` string, required — Id da cobrança
  - `dueDate` string, date — Data do vencimento da cobrança
  - `overDueDate` string, date — Data de expiração da cobrança
  - `createdAt` string — Data da criação
  - `amount` number — Valor
  - `batchId` string — Id do lote
  - `deliveryMediums` string[]
  - `interest` Interest
    - `startDate` string, date
    - `type` 'FIXED_VALUE_PER_DAY' | 'PERCENTAGE_PER_MONTH' | 'NOT_APPLICABLE'
    - `value` number
  - `fine` Fine
    - `startDate` string, date — Data incial
    - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
    - `value` number
  - `discounts` Discount[]
    - `limitDate` string, date — Data limite
    - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
    - `value` number
  - `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
  - `type` 'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX' — Boleto de cobrança
  - `payee` Payee — Emissor
    - `document` string
    - `fantasyName` string — Nome
    - `socialName` string — Nome
    - `bankCode` string — Código bancário
    - `bankName` string — Nome
  - `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[]
  - `description` string
  - `detail` Detail
    - `barCode` string — Código de barras
    - `digitableLine` string — Linha digitavel
    - `ourNumber` string — Nosso número da cobrança
    - `documentNumber` string — Número de documento da cobrança
    - `emv` string
    - `pixKey` string
    - `txId` string
    - `correlationId` string — Id de correlação da cobrança
    - `badCredit` BadCreditIssueDate — Informações de negativação para cobranças com type BANKSLIP ou BANKSLIP_QRCODE
      - `type` 'APPLICABLE' | 'NOT_APPLICABLE', required — Se NOT_APPLICABLE, o campo issueDate não deve ser informado
      - `issueDate` string — Data para negativar a cobrança
    - `automaticPix` AutomaticPix
      - `authorizationId` string, uuid — Id da autorização do Pix Automático
  - `tags` Tag[]
    - `key` string — Chave da tag
    - `value` string — Valor da tag
  - `updatedAt` string — Data da atualização

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `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)