post
https://pagamentos.meuk8.com.br/CobrancasAPI/api/v1/Cobranca
Esta API permite que seja inserido uma nova cobrança.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador único da cobrança | Não |
| IdentificadorSequencial | Número | Identificador sequencial da cobrança | Não |
| ClienteId | GUID | Identificador único do cliente | Sim |
| ClienteNome | Texto | Nome do cliente relacionado a cobrança | Não |
| Descricao | Texto | Descrição da cobrança | Sim |
| Valor | Numérico | 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 |
| Estado | Texto | Situação da cobrança | Sim |
| 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 aplicada na cobrança | Não |
| MultaCorrecao | Número | Tipo da multa a ser aplicada - 0 - "Percentual", 1 - "Valor" | Não |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança | Não |
| JurosCorrecao | Número | Tipo do juros a ser aplicado - 0 - "Percentual", 1 - "Valor" | Não |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento | Não |
| DescontoCorrecao | Número | Tipo do desconto a ser aplicado - 0 - "Percentual", 1 - "Valor" | 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 | Número | 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 |
| NotificacaoCobrancaCartaImpressa | Booleano | Se esta opção estiver marcada, o cliente receberá uma notificação via carta | Não |
| PrimeiraTentativaHabilitada | Booleano | Primeira tentativa de notificação com os dias vencidos | Não |
| PrimeiraTentativaDias | Número | 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 | Número | 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 | Número | 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 | Número | 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 | Quinta tentativa de notificação com os dias vencidos | Não |
| QuintaTentativaDias | Número | Número de dias vencidos | Não |
| QuintaTentativaEmail | Booleano | Quinta tentativa de notificação com os dias vencidos via e-mail | Não |
| QuintaTentativaSMS | Booleano | Quinta tentativa de notificação com os dias vencidos via SMS | Não |
| SextaTentativaHabilitada | Booleano | Sexta tentativa de notificação com os dias vencidos | Não |
| SextaTentativaDias | Número | Número de dias vencidos | Não |
| SextaTentativaEmail | Booleano | Sexta tentativa de notificação com os dias vencidos via e-mail | Não |
| SextaTentativaSMS | Booleano | Sexta tentativa de notificação com os dias vencidos via SMS | Não |
| SetimaTentativaHabilitada | Booleano | Sétima tentativa de notificação com os dias vencidos | Não |
| SetimaTentativaDias | Número | Número de dias vencidos | Não |
| SetimaTentativaEmail | Booleano | Sétima tentativa de notificação com os dias vencidos via e-mail | Não |
| SetimaTentativaSMS | Booleano | Sétima tentativa de notificação com os dias vencidos via SMS | Não |
| OitavaTentativaHabilitada | Booleano | Oitava tentativa de notificação com os dias vencidos | Não |
| OitavaTentativaDias | Número | Número de dias vencidos | Não |
| OitavaTentativaEmail | Booleano | Oitava tentativa de notificação com os dias vencidos via e-mail | Não |
| OitavaTentativaSMS | Booleano | Oitava tentativa de notificação com os dias vencidos via SMS | Não |
| NonaTentativaHabilitada | Booleano | Nona tentativa de notificação com os dias vencidos | Não |
| NonaTentativaDias | Número | Número de dias vencidos | Não |
| NonaTentativaEmail | Booleano | Nona tentativa de notificação com os dias vencidos via e-mail | Não |
| NonaTentativaSMS | Booleano | Nona tentativa de notificação com os dias vencidos via SMS | Não |
| DecimaTentativaHabilitada | Booleano | Décima tentativa de notificação com os dias vencidos | Não |
| DecimaTentativaDias | Número | Número de dias vencidos | Não |
| DecimaTentativaEmail | Booleano | Décima tentativa de notificação com os dias vencidos via e-mail | Não |
| DecimaTentativaSMS | Booleano | Décima tentativa de notificação com os dias vencidos via SMS | Não |
| ImgBase64 | Texto | Base64 do PDF do boleto ou link da imagem do QRCode PIX | Não |
| NumeroOperacao | Texto | Número referente a operação da cobrança | Não |
| 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 | Não |
| ClientePagamentosId | GUID | Identificador único do cliente relacionado ao split | Sim |
| Valor | Numérico | Valor de crédito para o participante do split | Sim |
| ClientePagamentosId | Texto | Id do cliente do pagamento | Não |
| NotaFiscal | Texto | Nota fiscal da cobrança | Não |
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 |
| 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…