Jump to Content
Guias
Documentação das APIs
Atualizações
v1.0
Log In
Documentação das APIs
Log In
v1.0
Guias
Documentação das APIs
Atualizações
Introdução API de Pagamentos (Gateway)
All
Pages
Start typing to search…
JUMP TO
API
Descubra o poder das APIs K8!
Códigos HTTP das respostas
K8 API PAGAMENTOS
Introdução API de Pagamentos (Gateway)
💡Dicas Importantes
AntiFraude
Antifraude
post
BaixaManual
Realiza a baixa manual de uma transação considerando-a como paga
post
CancelaTransacao
Cancela uma transação através de seu ID
post
CapturarTransacaoCartao
Este endpoint é responsável por realizar a captura de uma transacao pré-autorizada em um cartão de crédito.
post
ConsultaCartaoTitular
Analisa a titularidade de um cartão de crédito
post
ConsultaFrancesinha
Consulta transações pelos critérios definidos
post
ConsultaTransacao
Consulta os dados de uma transação
post
Consulta os dados de uma transação
post
ConsultaTransacoes
Consulta transações pelos critérios definidos
post
CriaTokenCartao
Cria um Token de cartão de crédito
put
Cria um Token de cartão de crédito
post
CriaTransacaoBoleto
Cria uma transação via boleto
post
CriaTransacaoBoletoHibrido
Cria uma transação de boleto híbrido (pix + boleto)
post
CriaTransacaoBoletoSplit
Cria uma transação via boleto com split dos valores
post
CriaTransacaoCartao
Cria uma transação via cartão de crédito
post
CriaTransacaoCartaoSplit
Cria uma transação via cartão de crédito com split dos valores
post
CriaTransacaoCartoes
Cria uma transação com pagamentos através de múltiplos cartões de crédito
post
CriaTransacaoCartoesSplit
Cria uma transação com pagamentos através de múltiplos cartões de crédito
post
CriaTransacaoCheckout
Cria uma transação com página de checkout completo, preferencialmente utilize a v2/CriaTransacaoCheckout, esta rota será desativada
post
CriaTransacaoPix
Cria uma transação via pix
post
CriaTransacaoPixSimples
Cria uma transação via pix
post
CriaTransacaoPixSimplesSplit
Cria uma transação via pix
post
CriaTransacaoPixSplit
Cria uma transação via pix com split dos valores
post
Especie31
Cria uma transação via boleto
post
Cria uma transação via boleto
post
Cria uma transação via boleto
post
EstornaTransacaoPIx
Estorna uma transação pix
post
GerarPDF
Gera a versão em PDF de um boleto
post
Marketplace
Cria uma transação via boleto
post
Cria uma transação via cartão
post
Cria transação para 2 cartões
post
Cria uma transação pix
post
Aprova a liberação do valor
put
Reprova a liberação do valor
put
Consulta transações por seller
post
Atualiza os dados de um seller
put
Registra uma seller
post
Consulta os sellers
get
NotaFiscal
Consulta as notas fiscais por IdEmpresa filtros
get
Gera uma nota fiscal, podendo ser vinculada a uma transação existente ou avulsa.
post
Cancela uma nota fiscal
del
NotaFiscalConfiguracao
Consulta a configuração de empresa para nota fiscal atual da empresa
get
Atualiza a configuração de empresa para nota fiscal atual da empresa
put
Insere a configuração de empresa para nota fiscal atual da empresa
post
Consulta a configuração de serviço para nota fiscal por id
get
Atualiza uma configuração de serviço para nota fiscal
put
Insere uma configuração de serviço para nota fiscal
post
Elimina uma configuração de serviço para nota fiscal por Id
del
Consulta as mensagens informativas para emissão de Notas Fiscais
get
Consulta os regimes especiais de tributação para emissão de Notas Fiscais
get
Protesto
Cria um protesto
post
Consulta protestos filtrando por data de inclusão e situação
get
Consulta um protesto por TituloID
get
Solicita o cancelamento de um protesto
del
Consulta o histórico do protesto
get
K8 API COBRANÇAS
Introdução API Cobranças
💡Dicas Importantes
Assinatura
Consulta Assinaturas
get
Atualiza uma assinatura
put
Insere assinatura
post
Consulta a assinatura por id
get
Elimina uma assinatura
del
Cliente
Cria ou Altera clientes em lote
post
Consulta por nome ou cpf/cnpj
get
Atualiza um cliente
put
Insere um cliente
post
Consulta por id
get
Elimina um cliente
del
Cobranca
Insere uma cobrança
post
Consulta cobranças
get
Atualiza uma cobrança
put
Insere uma cobrança
post
Consulta por id
get
Elimina uma cobrança
del
CobrancaAnexo
Consulta os anexos de uma cobrança informando o id do anexo
get
Consulta os anexos de uma cobrança informando o id da cobrança
get
Exclui um anexo
del
Insere anexo para cobrança
post
CobrancaBaixaManual
Calcula e realiza a baixa manual de uma cobrança
post
Calcula e baixa uma cobrança
get
CobrancaCarne
Cria cobrança do tipo carnê
post
Atualiza o carnê
put
Consulta Cobrança do tipo carnê
get
CobrancaFechamentoCaixa
Lista cobranças no caixa de baixas manuais e efetua fechamento
get
CobrancaImprimirBoleto
Gera os boletos de uma lista de cobranças
get
CobrancaPorClienteId
Consulta Cobranças por ClienteId
get
CobrancaTemBoletoGerado
Valida se o boleto já foi gerado
get
CobrancaVisualizar
Cobranca Visualizar
get
LinkPagamento
Consulta os links de pagamento por nome
get
Atualiza um link de pagamento por Id
put
Insere um link de pagamento
post
Consulta o link de pagamento por id
get
Elimina um link de pagamento por Id
del
LinkPagamentoEstatistica
Consulta as estatísticas por link
get
LinkPagamentoVisualizar
Gera a URL de um link de pagamento
get
NotaFiscal
Consulta as notas fiscais por descrição e cliente
get
Gera uma nota fiscal, podendo ser vinculada a uma cobrança existente ou avulsa.
post
Cancela uma nota fiscal
del
NotaFiscalConfiguracaoEmpresa
Consulta a configuração de empresa para nota fiscal atual da empresa
get
Atualiza a configuração de empresa para nota fiscal atual da empresa
put
Insere a configuração de empresa para nota fiscal atual da empresa
post
NotaFiscalConfiguracaoServico
Consulta os serviços para notas fiscais
get
Atualiza uma configuração de serviço para nota fiscal
put
Insere uma configuração de serviço para nota fiscal
post
Consulta a configuração de serviço para nota fiscal por id
get
Elimina uma configuração de serviço para nota fiscal por Id
del
NotaFiscalConsultaServicos
Consulta as serviços do município para emissão de Notas Fiscais
get
NotaFiscalMensagens
Consulta as mensagens informativas para emissão de Notas Fiscais
get
NotaFiscalRegimesEspeciaisTributacao
Consulta os regimes especiais de tributação para emissão de Notas Fiscais
get
Produto
Consulta os produtos por nome
get
Atualiza um produto
put
Insere um produto
post
Consulta o produto por id
get
Elimina um produto por Id
del
Protesto
Cria um protesto
post
Solicita o cancelamento de um protesto
del
Consulta os protestos por descrição e cliente
get
ProtestoHistorico
Consulta o histórico do protesto
get
Seller
Consulta Sellers
get
Atualiza os dados de uma seller previamente cadastrado
put
Registra uma seller , vinculando ele ao executor da chamada
post
K8 API Conta
Autenticação
Obtenção do grant code
post
Obtenção do Access Token
post
Obtenção do Refresh Access Token
post
Convites
Enviar Convite
post
Empresas
Consultar informações de um convite já enviado.
get
Consultar informações de uma proposta.
get
Pagamentos
Consultar informações de um Boleto/Conta de Consumo
post
Realizar a criação de uma transação de um boleto/conta de consumo
post
Consultar informações de uma chave pix
post
Criar uma transação pix.
post
Realiza a rejeição de uma transação.
post
Realizar a criação de uma transação TED ou TEI
post
Realiza a consulta da lista de DDA.
get
Consulta de status da transação
post
Consulta de dados de pagamentos
get
Extrato
Realizar a consulta do saldo total da conta.
get
Realizar a consulta do extrato
post
Consulta extrato pix
get
Exportar extrato pix
get
Dados Bancários
Realiza a consulta das informações e credenciais de uma conta.
get
Faturamento
Cadastro dos dados de faturamento do cliente
post
Cadastro de Urls
Cadastro de URLs para webhooks de conta
post
Cadastro de URLs para webhooks de label
post
Onboarding PF
Cadastro dos dados cadastrais
post
Cadastro dos dados cadastrais
post
Consulta status
get
Cadastro de conta adicional
post
Consulta CPF
post
Consulta resultado CPF
get
K8 Fintech
CriaTransacaoCheckout
Cria uma transação com página de checkout completo
post
Powered by
Introdução API de Pagamentos (Gateway)
Ask AI
