---
title: "Consulta Cobrança do tipo carnê"
method: GET
path: "/api/CobrancaCarne/ConsultaCarne"
tags: ["CobrancaCarne"]
---

# Consulta Cobrança do tipo carnê

`GET /api/CobrancaCarne/ConsultaCarne`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI`
- URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaCarne/ConsultaCarne`
- Auth: OAuth 2
  - Password
  - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI`

Esta API permite realizar consulta dos carnês através do Id.

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| Id | GUID | ID do carnê já cadastrado| Sim |

### Resposta 
| **Campo** | **Tipo** | **Descrição** |
|--|--|--| 
| CarneId | GUID | Identificador único do carnê gerado|
| Estado | Texto | Estado que o carnê se encontra |
| ImgBase64 | Texto | Base64 do PDF completo do carnê |
| **Parcelas** | Lista de Objetos | Lista com o detalhamento de cada parcela |
| CobrancaId | GUID | Identificador único da Cobrança gerada |
| EstadoParcela | Texto | Estado da cobrança |
| Valor | Numérico | Valor da parcela |
| Vencimento | Data | Data de vencimento da parcela |
| NossoNumero | Texto | Nosso Número do boleto gerado |
| LinhaDigitavel | Texto | Linha digitável do boleto gerado |
| CodigoBarras | Texto | Código de Barras do boleto gerado |
| QRCodeTexto | Texto | Copia e cola do pix (se for gerado como Boleto Híbrido) |
| QRCodeImagem | Texto | Imagem do QRCode do pix (se for gerado como Boleto Híbrido) |
| **DadosPagamento** | Objeto | Dados do pagamento, vêm sempre nulos no momento da criação |   
| Id | GUID | Identificador único do Pagamento | 
| Situacao | Texto | Situação do pagamento | 
| DataPagamento | Data | Data do pagamento | 
| FormaPagamento | Texto | Forma de pagamento | 
| DadosPagamento | Texto | Dados do pagamento, ex: número do boleto ou copia e cola do pix | 
| NumeroMovimentoFinanceiro | Texto | Número do movimento financeiro relacionado ao pagamento | 
| ValorPago | Numérico | Valor pago da cobrança | 
| ValorPrincipal | Numérico | Valor liquido da cobrança | 
| ValorMultaJuros | Numérico | Valor de multa aplicado | 
| NumeroPagamento | Texto | Número do pagamento, ex: qr code do pix | 
| ValorTaxas | Numérico | Valor total das taxas associadas | 
| ValorLiquido | Numérico | Valor pago - valor das taxas | 
| DataDisponibilizacao | Data | Data de disponibilização do pagamento | 
| ReembolsadoAoCliente | Booleano | Indicador se o pagamento foi reembolsado ao cliente | 
| Antecipado | Booleano | Indicador se o pagamento foi antecipado | 
| TransacaoId | GUID | Identificador único da transação relacionada aquele pagamento | 
| CobrancaId | GUID | Identificador único da cobrança relacionada aquele pagamento | 
| CanalPagamento | Número | Canal por onde o pagamento foi realizado - "NaoDefinido = 0", "AgenciasPostosTradicionais = 1", "TerminalAutoAtendimento = 2", "Internet = 3", "Pix = 4", "CorrespondenteBancario = 5", "CentralAtendimento = 6", "ArquivoEletronico = 7", "DDA = 8", "CorrespondenteBancarioDigital = 9"| 
| MeioPagamento | Número | Meio de pagamento utilizado na transação - "NaoDefinido = 0", "Especie = 1", "DebitoEmConta = 2","CartaoCredito = 3", "Cheque = 4" |

## Query parameters

- `Id` string, required

## Headers

- `Aeskey` string, required

## Response `200`

Cobrança do tipo Carnê consultada

- BknBankCobrancasAPIModelsCobrancaCarneResponse
  - `CarneId` string, uuid
  - `Estado` 'Todos' | 'EmDia' | 'Finalizada' | 'Cancelada' | 'GerandoCarne' | 'Erro'
  - `ImgBase64` string
  - `Parcelas` BknBankCobrancasAPIModelsParcela[]
    - `CobrancaId` string, uuid
    - `EstadoParcela` 'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada'
    - `Valor` number, double
    - `Vencimento` string, date-time
    - `NossoNumero` string
    - `LinhaDigitavel` string
    - `CodigoBarras` string
    - `QRCodeTexto` string
    - `QRCodeImagem` string
    - `DadosPagamento` BknBankCobrancasAPIModelsPagamento: Modelo de Pagamento
      - `Id` string: Id do pagamento
      - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação do pagamento
      - `DataPagamento` string, date-time: Data do pagamento
      - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento
      - `DadosPagamento` string: Dados do pagamento
      - `ValorPago` number, double: Valor pago de pagamento
      - `ValorPrincipal` number, double: Valor principal de pagamento
      - `ValorMultaJuros` number, double: Valor multa/juros de pagamento
      - `NumeroPagamento` string: Número do pagamento
      - `ValorTaxas` number, double: Valor das taxas de pagamento
      - `ValorLiquido` number, double: Valor líquido de pagamento
      - `DataDisponibilizacao` string, date-time: Data de disponibilização pagamento
      - `ReembolsadoAoCliente` boolean: Indicação de reembolsado ao cliente do pagamento
      - `Antecipado` boolean: Indicativo se o pagamento foi antecipado
      - `TransacaoId` string, uuid: Id da Transacao relacionada a este pagamento
      - `CobrancaId` string, uuid: Id da Cobrança relacionada a este pagamento
      - `CanalPagamento` integer
      - `MeioPagamento` integer

## Other responses

- `401`: Não há permissão para acessar este carnê
- `404`: Carnê não encontrado
- `500`: Id inválido do carnê ou erro carregando o mesmo

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)