post
https://pagamentos.meuk8.com.br/CobrancasAPI/api/v1/Cobranca
Esta API permite que seja inserido uma nova cobrança, através dos dados do cliente.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| ClienteId | GUID | Identificador único do cliente | Sim |
| ClienteNome | Texto | Nome do cliente relacionado a cobrança | Não |
| Descricao | Texto | Descrição com mais detalhes sobre a cobrança | Sim |
| Valor | Data | Valor a ser pago na cobrança | Sim |
| Vencimento | Data | Data de vencimento da cobrança | Sim |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela | Não |
| Tipo | Texto | Tipo da cobrança, sendo possível apenas avulsa | Não |
| Estado | Texto | Situação da cobrança | Não |
| FormasPagamento | Texto | Formas de pagamento da cobrança | Sim |
| ProdutoId | GUID | Identificador único do produto(forma simplificada da cobrança) | Não |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança | Não |
| MultaCorrecao | Texto | Tipo da multa a ser aplicada | Não |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança | Não |
| JurosCorrecao | Texto | Tipo do juros a ser aplicado | Não |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento | Não |
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado | Não |
| Instrucao1 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final | Não |
| Instrucao2 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final | Não |
| Instrucao3 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final | Não |
| Instrucao4 | Texto | Deve ser utilizado para adicionar informações adicionais destinadas ao usuário final | Não |
| NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação | Não |
| NotificacaoCobrancaEmail | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via e-mail | Não |
| NotificacaoCobrancaSMS | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via SMS | Não |
| PrimeiraTentativaHabilitada | Booleano | Primeira tentativa de notificação com os dias vencidos | Não |
| PrimeiraTentativaDias | Numérico | Número de dias vencidos | Não |
| PrimeiraTentativaEmail | Booleano | Primeira tentativa de notificação com os dias vencidos via e-mail | Não |
| PrimeiraTentativaSMS | Booleano | Primeira tentativa de notificação com os dias vencidos via SMS | Não |
| SegundaTentativaHabilitada | Booleano | Segunda tentativa de notificação com os dias vencidos | Não |
| SegundaTentativaDias | Numérico | Número de dias vencidos | Não |
| SegundaTentativaEmail | Booleano | Segunda tentativa de notificação com os dias vencidos via e-mail | Não |
| SegundaTentativaSMS | Booleano | Segunda tentativa de notificação com os dias vencidos via SMS | Não |
| TerceiraTentativaHabilitada | Booleano | Terceira tentativa de notificação com os dias vencidos | Não |
| TerceiraTentativaDias | Numérico | Número de dias vencidos | Não |
| TerceiraTentativaEmail | Booleano | Terceira tentativa de notificação com os dias vencidos via e-mail | Não |
| TerceiraTentativaSMS | Booleano | Terceira tentativa de notificação com os dias vencidos via SMS | Não |
| QuartaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| QuartaTentativaDias | Numérico | Número de dias vencidos | Não |
| QuartaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| QuartaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| QuintaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| QuintaTentativaDias | Numérico | Número de dias vencidos | Não |
| QuintaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| QuintaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| SextaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| SextaTentativaDias | Numérico | Número de dias vencidos | Não |
| SextaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| SextaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| SetimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| SetimaTentativaDias | Numérico | Número de dias vencidos | Não |
| SetimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| SetimaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| OitavaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| OitavaTentativaDias | Numérico | Número de dias vencidos | Não |
| OitavaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| OitavaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| NonaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| NonaTentativaDias | Numérico | Número de dias vencidos | Não |
| NonaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| NonaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| DecimaTentativaHabilitada | Booleano | Quarta tentativa de notificação com os dias vencidos | Não |
| DecimaTentativaDias | Numérico | Número de dias vencidos | Não |
| DecimaTentativaEmail | Booleano | Quarta tentativa de notificação com os dias vencidos via e-mail | Não |
| DecimaTentativaSMS | Booleano | Quarta tentativa de notificação com os dias vencidos via SMS | Não |
| ImgBase64 | Imagem | Imagem | Não |
| NumeroOperacao | Numérico | Número referente a operação da cobrança | Não |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do meuK8, a partir do código de cliente e do valor respectivo | Não |
| ClientePagamentosId | Texto | Id do cliente do pagamento | Não |
| NotaFiscal | Texto | Nota fiscal da Cobrança | Não |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…