MEmeuk8
Cobranca

POST /api/Cobranca

Request

  • Base URL
    https://pagamentos.meuk8.com.br/CobrancasAPI
  • URL
    https://pagamentos.meuk8.com.br/CobrancasAPI/api/Cobranca
  • Auth
    OAuth 2
    Password
    Token URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI

Headers

Aeskeystring required

Request body

Idstring
IdentificadorSequencialinteger
ClienteIdstring uuid

Id do cliente relacionado a cobrança

ClienteNomestring

Nome do cliente relacionado a cobrança, somente para retornar dados

Descricaostring

Descrição da cobrança

Criacaostring date-time

Data de criação da cobrança

Valornumber double

Valor da cobrança

Vencimentostring date-time

Data de vencimento da cobrança

NaoReceberDepoisDestring date-time

Data para não aceitar pagamento da cobrança

Estado'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada'

Estado da cobrança

FormasPagamento'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta'

Formas de pagamento da cobrança

ProdutoIdstring uuid

Id do produto relacionado a cobrança

Multanumber double

Valor

MultaCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao da multa (percentual ou valor)

JurosMesnumber double

Valor

JurosCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao dos juros (percentual ou valor)

DescontoAteVencimentonumber double

Valor

DescontoCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

Desconto2number double

Valor

DescontoCorrecao2'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

DataDesconto2string date-time

O desconto será valido até essa data

Desconto3number double

Valor

DescontoCorrecao3'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

DataDesconto3string date-time

O desconto será valido até essa data

Instrucao1string

Instrucao1 em texto

Instrucao2string

Instrucao2 em texto

Instrucao3string

Instrucao3 em texto

Instrucao4string

Instrucao4 em texto

NotificacaoCobrancaDiasinteger

Dias antes do vencimento para notificar

NotificacaoCobrancaEMailboolean

Notificação via EMail

NotificacaoCobrancaSMSboolean

Notificação via SMS

PrimeiraTentativaHabilitadaboolean

Habilitado primeira tentativa em atraso

PrimeiraTentativaDiasinteger

Dias primeira tentativa em atraso

PrimeiraTentativaEMailboolean

Email da primeira tentativa em atraso

PrimeiraTentativaSMSboolean

SMS da primeira tentativa em atraso

SegundaTentativaHabilitadaboolean

Habilitado segunda tentativa em atraso

SegundaTentativaDiasinteger

Dias segunda tentativa em atraso

SegundaTentativaEMailboolean

Email da segunda tentativa em atraso

SegundaTentativaSMSboolean

SMS da segunda tentativa em atraso

TerceiraTentativaHabilitadaboolean

Habilitado terceira tentativa em atraso

TerceiraTentativaDiasinteger

Dias terceira tentativa em atraso

TerceiraTentativaEMailboolean

Email da terceira tentativa em atraso

TerceiraTentativaSMSboolean

SMS da terceira tentativa em atraso

QuartaTentativaHabilitadaboolean

Habilitado quarta tentativa em atraso

QuartaTentativaDiasinteger

Dias quarta tentativa em atraso

QuartaTentativaEMailboolean

Email da quarta tentativa em atraso

QuartaTentativaSMSboolean

SMS da quarta tentativa em atraso

QuintaTentativaHabilitadaboolean

Habilitado Quinta tentativa em atraso

QuintaTentativaDiasinteger

Dias Quinta tentativa em atraso

QuintaTentativaEMailboolean

Email da Quinta tentativa em atraso

QuintaTentativaSMSboolean

SMS da Quinta tentativa em atraso

SextaTentativaHabilitadaboolean

Habilitado Sexta tentativa em atraso

SextaTentativaDiasinteger

Dias Sexta tentativa em atraso

SextaTentativaEMailboolean

Email da Sexta tentativa em atraso

SextaTentativaSMSboolean

SMS da Sexta tentativa em atraso

SetimaTentativaHabilitadaboolean

Habilitado Sétima tentativa em atraso

SetimaTentativaDiasinteger

Dias Sétima tentativa em atraso

SetimaTentativaEMailboolean

Email da Sétima tentativa em atraso

SetimaTentativaSMSboolean

SMS da Sétima tentativa em atraso

OitavaTentativaHabilitadaboolean

Habilitado Oitava tentativa em atraso

OitavaTentativaDiasinteger

Dias Oitava tentativa em atraso

OitavaTentativaEMailboolean

Email da Oitava tentativa em atraso

OitavaTentativaSMSboolean

SMS da Oitava tentativa em atraso

NonaTentativaHabilitadaboolean

Habilitado Nona tentativa em atraso

NonaTentativaDiasinteger

Dias Nona tentativa em atraso

NonaTentativaEMailboolean

Email da Nona tentativa em atraso

NonaTentativaSMSboolean

SMS da Nona tentativa em atraso

DecimaTentativaHabilitadaboolean

Habilitado Décima tentativa em atraso

DecimaTentativaDiasinteger

Dias Décima tentativa em atraso

DecimaTentativaEMailboolean

Email da Décima tentativa em atraso

DecimaTentativaSMSboolean

SMS da Décima tentativa em atraso

ImgBase64string
NumeroOperacaostring
ClientePagamentosIdstring uuid
NotaFiscalstring

Example request

{
  "ClienteId": "00000000-0000-0000-0000-000000000000",
  "ProdutoId": "00000000-0000-0000-0000-000000000000",
  "DadosPagamento": {
    "TransacaoId": "00000000-0000-0000-0000-000000000000",
    "CobrancaId": "00000000-0000-0000-0000-000000000000"
  },
  "SplitValores": [
    {
      "ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
}

Response

Cobrança criada

Idstring
IdentificadorSequencialinteger
ClienteIdstring uuid

Id do cliente relacionado a cobrança

ClienteNomestring

Nome do cliente relacionado a cobrança, somente para retornar dados

Descricaostring

Descrição da cobrança

Criacaostring date-time

Data de criação da cobrança

Valornumber double

Valor da cobrança

Vencimentostring date-time

Data de vencimento da cobrança

NaoReceberDepoisDestring date-time

Data para não aceitar pagamento da cobrança

Estado'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada'

Estado da cobrança

FormasPagamento'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta'

Formas de pagamento da cobrança

ProdutoIdstring uuid

Id do produto relacionado a cobrança

Multanumber double

Valor

MultaCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao da multa (percentual ou valor)

JurosMesnumber double

Valor

JurosCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao dos juros (percentual ou valor)

DescontoAteVencimentonumber double

Valor

DescontoCorrecao'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

Desconto2number double

Valor

DescontoCorrecao2'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

DataDesconto2string date-time

O desconto será valido até essa data

Desconto3number double

Valor

DescontoCorrecao3'Percentual' | 'Valor' | 'Diario' | 'Isento'

Forma de correcao do desconto (percentual ou valor)

DataDesconto3string date-time

O desconto será valido até essa data

Instrucao1string

Instrucao1 em texto

Instrucao2string

Instrucao2 em texto

Instrucao3string

Instrucao3 em texto

Instrucao4string

Instrucao4 em texto

NotificacaoCobrancaDiasinteger

Dias antes do vencimento para notificar

NotificacaoCobrancaEMailboolean

Notificação via EMail

NotificacaoCobrancaSMSboolean

Notificação via SMS

PrimeiraTentativaHabilitadaboolean

Habilitado primeira tentativa em atraso

PrimeiraTentativaDiasinteger

Dias primeira tentativa em atraso

PrimeiraTentativaEMailboolean

Email da primeira tentativa em atraso

PrimeiraTentativaSMSboolean

SMS da primeira tentativa em atraso

SegundaTentativaHabilitadaboolean

Habilitado segunda tentativa em atraso

SegundaTentativaDiasinteger

Dias segunda tentativa em atraso

SegundaTentativaEMailboolean

Email da segunda tentativa em atraso

SegundaTentativaSMSboolean

SMS da segunda tentativa em atraso

TerceiraTentativaHabilitadaboolean

Habilitado terceira tentativa em atraso

TerceiraTentativaDiasinteger

Dias terceira tentativa em atraso

TerceiraTentativaEMailboolean

Email da terceira tentativa em atraso

TerceiraTentativaSMSboolean

SMS da terceira tentativa em atraso

QuartaTentativaHabilitadaboolean

Habilitado quarta tentativa em atraso

QuartaTentativaDiasinteger

Dias quarta tentativa em atraso

QuartaTentativaEMailboolean

Email da quarta tentativa em atraso

QuartaTentativaSMSboolean

SMS da quarta tentativa em atraso

QuintaTentativaHabilitadaboolean

Habilitado Quinta tentativa em atraso

QuintaTentativaDiasinteger

Dias Quinta tentativa em atraso

QuintaTentativaEMailboolean

Email da Quinta tentativa em atraso

QuintaTentativaSMSboolean

SMS da Quinta tentativa em atraso

SextaTentativaHabilitadaboolean

Habilitado Sexta tentativa em atraso

SextaTentativaDiasinteger

Dias Sexta tentativa em atraso

SextaTentativaEMailboolean

Email da Sexta tentativa em atraso

SextaTentativaSMSboolean

SMS da Sexta tentativa em atraso

SetimaTentativaHabilitadaboolean

Habilitado Sétima tentativa em atraso

SetimaTentativaDiasinteger

Dias Sétima tentativa em atraso

SetimaTentativaEMailboolean

Email da Sétima tentativa em atraso

SetimaTentativaSMSboolean

SMS da Sétima tentativa em atraso

OitavaTentativaHabilitadaboolean

Habilitado Oitava tentativa em atraso

OitavaTentativaDiasinteger

Dias Oitava tentativa em atraso

OitavaTentativaEMailboolean

Email da Oitava tentativa em atraso

OitavaTentativaSMSboolean

SMS da Oitava tentativa em atraso

NonaTentativaHabilitadaboolean

Habilitado Nona tentativa em atraso

NonaTentativaDiasinteger

Dias Nona tentativa em atraso

NonaTentativaEMailboolean

Email da Nona tentativa em atraso

NonaTentativaSMSboolean

SMS da Nona tentativa em atraso

DecimaTentativaHabilitadaboolean

Habilitado Décima tentativa em atraso

DecimaTentativaDiasinteger

Dias Décima tentativa em atraso

DecimaTentativaEMailboolean

Email da Décima tentativa em atraso

DecimaTentativaSMSboolean

SMS da Décima tentativa em atraso

ImgBase64string
NumeroOperacaostring
ClientePagamentosIdstring uuid
NotaFiscalstring

Example response

{
  "ClienteId": "00000000-0000-0000-0000-000000000000",
  "ProdutoId": "00000000-0000-0000-0000-000000000000",
  "DadosPagamento": {
    "TransacaoId": "00000000-0000-0000-0000-000000000000",
    "CobrancaId": "00000000-0000-0000-0000-000000000000"
  },
  "SplitValores": [
    {
      "ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "ClientePagamentosId": "00000000-0000-0000-0000-000000000000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.