Especie31

Cria uma transação via boleto especie 31

Changed on

Requisição

CampoTipoDescriçãoObrigatório
ValorNuméricoValor do boleto a ser pagoSim
DataVencimentoDataData de vencimento do boletoSim
URLConfirmacaoTextoURL para onde será enviado o callback de confirmação de pagamentoNão
ClienteDescricaoTextoDescrição do cliente pagadorSim
ClienteIPTextoIP do cliente pagadorSim
ClienteCPFCNPJTextoCPF ou CNPJ do cliente pagadorSim
ClienteNomeTextoNome do cliente pagadorSim
ClienteEmailTextoEmail do cliente pagadorNão
ClienteEnderecoTextoEndereço do cliente pagadorSim
ClienteBairroTextoBairro do cliente pagadorSim
ClienteCidadeTextoCidade do cliente pagadorSim
ClienteCEPTextoCEP do cliente pagadorSim
ClienteUFTextoUF do cliente pagadorSim
ClienteDDDTextoDDD do telefone do cliente pagadorNão
ClienteNumeroCelularTextoNúmero do celular do cliente pagadorNão
NumeroPedidoTextoNúmero do pedido relacionado ao boletoNão
NossoNumeroTextoNosso número do boleto (identificador do boleto)Sim
SeuNumeroTextoSeu número do boleto (identificador do cliente para o boleto)Não
ValorMinimoNuméricoValor mínimo para pagamento do boletoNão
JurosNuméricoValor do juros para pagamento após o vencimentoNão
MultaNuméricoValor da multa para pagamento após o vencimentoNão

Resposta

CampoTipoDescrição
RetornoTextoRetorno da operação (Ok ou Erro)
DetalhesErroTextoDetalhes do erro ocorrido (em caso de erro)
IdentificadorTextoIdentificador da transação criada (em caso de sucesso)
StatusRegistroTextoStatus do registro da transação (em caso de sucesso)
CodigoErroTextoCódigo do erro ocorrido (em caso de erro)
post/api/especie31/criartitulo

Request

  • Base URL
    https://pagamentos.meuk8.com.br/PagamentosAPI
  • URL
    https://pagamentos.meuk8.com.br/PagamentosAPI/api/especie31/criartitulo
  • Auth
    OAuth 2
    Password
    Token URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI

Headers

Aeskeystring required

Request body

Valornumber double
DataVencimentostring date-time required
URLConfirmacaostring
ClienteDescricaostring required
ClienteIPstring required
ClienteCPFCNPJstring required
ClienteNomestring required
ClienteEmailstring
ClienteEnderecostring
ClienteBairrostring
ClienteCidadestring
ClienteCEPstring
ClienteUFstring
ClienteDDDstring
ClienteNumeroCelularstring
NumeroPedidostring
NossoNumerostring
SeuNumerostring
ValorMinimonumber double
Jurosnumber double
Multanumber double

Example request

{
  "Valor": 103.24,
  "DataVencimento": "2026-08-19T10:20:28.6689382-03:00",
  "URLConfirmacao": "https://www.meusite.com.br/webhook/confirmacao-transacao",
  "ClienteDescricao": "Cliente Gold Nivel 25",
  "ClienteIP": "127.0.0.1",
  "ClienteCPFCNPJ": "48455151480",
  "ClienteNome": "Renato Samuel Augusto Baptista",
  "ClienteEmail": "renatosamuel@umdominio.com.br",
  "ClienteEndereco": "Rua Canadá, 257",
  "ClienteBairro": "Bacacheri",
  "ClienteCidade": "Curitiba",
  "ClienteCEP": "82510290",
  "ClienteUF": "PR",
  "ClienteDDD": "41",
  "ClienteNumeroCelular": "999293802",
  "NumeroPedido": "pedido.2026081910",
  "NossoNumero": "334172567890",
  "SeuNumero": "402312",
  "ValorMinimo": 48.16,
  "Juros": 0,
  "Multa": 0
}

Response

Criar Titulo Especie31

Retorno'OK' | 'ERRO'
DetalhesErrostring
Identificadorstring
StatusRegistrostring
CodigoErrostring

Changes

    • info

      removed the pattern ^(\d)+$ from the request property (media type: application/json)

    • info

      removed the pattern ^(\d)+$ from the request property (media type: text/json)

    • info

      removed the pattern ^(\d)+$ from the request property (media type: application/xml)

    • info

      removed the pattern ^(\d)+$ from the request property (media type: text/xml)

    • info

      removed the pattern ^(\d)+$ from the request property (media type: application/x-www-form-urlencoded)

    • info

      removed the non-success response with the status