CobrancaCarne
Consulta Cobrança do tipo carnê
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" |
get/api/CobrancaCarne/ConsultaCarne
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaCarne/ConsultaCarne
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Query parameters
Idstring required
Id do carnê já cadastrado
Headers
Aeskeystring required
Response
Cobrança do tipo Carnê consultada
Example response
{
"CarneId": "00000000-0000-0000-0000-000000000000",
"Parcelas": [
{
"CobrancaId": "00000000-0000-0000-0000-000000000000",
"DadosPagamento": {
"TransacaoId": "00000000-0000-0000-0000-000000000000",
"CobrancaId": "00000000-0000-0000-0000-000000000000"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.