get
https://pagamentos.meuk8.com.br/CobrancasAPI/api/Cobranca/
Esta API permite a consulta de cobranças através do ID.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador único da Cobrança | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Id | GUID | Identificador único da cobrança |
| IdentificadorSequencial | Número | Identificador sequencial da cobrança |
| ClienteId | GUID | Identificador único do cliente |
| ClienteNome | Texto | Nome do cliente relacionado a cobrança |
| Descricao | Texto | Descrição da cobrança |
| Criacao | Data | Data em que a cobrança foi gerada |
| Valor | Numérico | Valor a ser pago na cobrança |
| Vencimento | Data | Data de vencimento da cobrança |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela |
| Estado | Texto | Situação da cobrança |
| FormasPagamento | Texto | Formas de pagamento da cobrança |
| ProdutoId | GUID | Identificador único do produto(forma simplificada da cobrança) |
| Multa | Numérico | Valor da multa a ser aplicada na cobrança |
| MultaCorrecao | Número | Tipo da multa a ser aplicada - 0 - "Percentual", 1 - "Valor" |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança |
| JurosCorrecao | Número | Tipo do juros a ser aplicado - 0 - "Percentual", 1 - "Valor" |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
| DescontoCorrecao | Número | Tipo do desconto a ser aplicado - 0 - "Percentual", 1 - "Valor" |
| Instrucao1 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao2 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao3 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| Instrucao4 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final |
| DadosPagamento | Objeto | Dados do pagamento da cobrança |
| 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" |
| NotificacaoCobrancaDias | Número | Dias antes do vencimento da cobrança para enviar a notificação |
| NotificacaoCobrancaEmail | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via e-mail |
| NotificacaoCobrancaSMS | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via SMS |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via carta |
| PrimeiraTentativaHabilitada | Booleano | Primeira tentativa de notificação com os dias vencidos |
| PrimeiraTentativaDias | Número | Número de dias vencidos |
| PrimeiraTentativaEmail | Booleano | Primeira tentativa de notificação com os dias vencidos via e-mail |
| PrimeiraTentativaSMS | Booleano | Primeira tentativa de notificação com os dias vencidos via SMS |
| SegundaTentativaHabilitada | Booleano | Segunda tentativa de notificação com os dias vencidos |
| SegundaTentativaDias | Número | Número de dias vencidos |
| SegundaTentativaEmail | Booleano | Segunda tentativa de notificação com os dias vencidos via e-mail |
| SegundaTentativaSMS | Booleano | Segunda tentativa de notificação com os dias vencidos via SMS |
| TerceiraTentativaHabilitada | Booleano | Terceira tentativa de notificação com os dias vencidos |
| TerceiraTentativaDias | Número | Número de dias vencidos |
| TerceiraTentativaEmail | Booleano | Terceira tentativa de notificação com os dias vencidos via e-mail |
| TerceiraTentativaSMS | Booleano | Terceira tentativa de notificação com os dias vencidos via SMS |
| QuartaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos |
| QuartaTentativaDias | Número | Número de dias vencidos |
| QuartaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
| QuartaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS |
| QuintaTentativaHabilitada | Booleano | Quinta tentativa de notificação com os dias vencidos |
| QuintaTentativaDias | Número | Número de dias vencidos |
| QuintaTentativaEmail | Booleano | Quinta tentativa de notificação com os dias vencidos via e-mail |
| QuintaTentativaSMS | Booleano | Quinta tentativa de notificação com os dias vencidos via SMS |
| SextaTentativaHabilitada | Booleano | Sexta tentativa de notificação com os dias vencidos |
| SextaTentativaDias | Número | Número de dias vencidos |
| SextaTentativaEmail | Booleano | Sexta tentativa de notificação com os dias vencidos via e-mail |
| SextaTentativaSMS | Booleano | Sexta tentativa de notificação com os dias vencidos via SMS |
| SetimaTentativaHabilitada | Booleano | Sétima tentativa de notificação com os dias vencidos |
| SetimaTentativaDias | Número | Número de dias vencidos |
| SetimaTentativaEmail | Booleano | Sétima tentativa de notificação com os dias vencidos via e-mail |
| SetimaTentativaSMS | Booleano | Sétima tentativa de notificação com os dias vencidos via SMS |
| OitavaTentativaHabilitada | Booleano | Oitava tentativa de notificação com os dias vencidos |
| OitavaTentativaDias | Número | Número de dias vencidos |
| OitavaTentativaEmail | Booleano | Oitava tentativa de notificação com os dias vencidos via e-mail |
| OitavaTentativaSMS | Booleano | Oitava tentativa de notificação com os dias vencidos via SMS |
| NonaTentativaHabilitada | Booleano | Nona tentativa de notificação com os dias vencidos |
| NonaTentativaDias | Número | Número de dias vencidos |
| NonaTentativaEmail | Booleano | Nona tentativa de notificação com os dias vencidos via e-mail |
| NonaTentativaSMS | Booleano | Nona tentativa de notificação com os dias vencidos via SMS |
| DecimaTentativaHabilitada | Booleano | Décima tentativa de notificação com os dias vencidos |
| DecimaTentativaDias | Número | Número de dias vencidos |
| DecimaTentativaEmail | Booleano | Décima tentativa de notificação com os dias vencidos via e-mail |
| DecimaTentativaSMS | Booleano | Décima tentativa de notificação com os dias vencidos via SMS |
| ImgBase64 | Texto | Base64 do PDF do boleto ou link da imagem do QRCode PIX |
| NumeroOperacao | Texto | Número referente a operação da cobrança |
| SplitValores | Array de Objeto | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas MeuK8, a partir do código de cliente e do valor respectivo |
| ClientePagamentosId | GUID | Identificador único do cliente relacionado ao split |
| Valor | Numérico | Valor de crédito para o participante do split |
| ClientePagamentosId | Texto | Id do cliente do pagamento |
| NotaFiscal | Texto | Nota fiscal da cobrança |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…