Jump to Content
Guias
Referência da API
v1.0
v2.0
Site
Central de Ajuda
API Status
Referência da API
Site
Central de Ajuda
API Status
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guias
Referência da API
Criar um Cliente
Search
JUMP TO
Kobana API
Visão Geral
Endpoints
User-Agent
Limite de Requisições
Autenticação
Token de Acesso
Fluxo de autorização
Fluxo credenciais do cliente
Permissões
Idempotência
Bancos Suportados
ABC Brasil
Ailos
Arbi
Banco de Brasília
Banco do Brasil
Banco do Nordeste
Banco Industrial do Brasil
Banco Mercantil
Banese
Banestes
Banrisul
BNP Paribas
Bocom BBM
Bradesco
BV
BTG
Caixa Econômica Federal
Caruana
Citibank
Cora
Credisis
Cresol
Daycoval
Itaú
Inter
Money Plus (BMP)
PJ Bank
Rendimento
Safra
Semear
Santander
SICOOB
Sicredi
Sisprime
Sofisa
Unicred do Brasil
Códigos de Erros
Cobranças
Boletos
Criar um Boleto
post
Listar Boletos
get
Visualizar o Boleto
get
Atualizar o Boleto
put
Cancelar o Boleto
put
Duplicar Boleto
post
Marcar Boleto Como Pago
put
Cancelar Boletos em Lote
post
Enviar Boleto por E-mail
post
Enviar Boleto por SMS
post
Clientes
Criar um Cliente
post
Listar Clientes
get
Visualizar o Cliente
get
Atualizar Cliente
put
Busca Cliente por CNPJ/CPF
get
Busca Cliente por E-mail
get
Carnês
Listar Carnês
get
Criar um Carnê
post
Informações do Carnê
get
Excluir o Carnê
delete
Assinaturas
Criar uma Assinatura
post
Listar Assinaturas
get
Informações da Assinatura
get
Atualizar a Assinatura
put
Excluir a Assinatura
delete
Gerar Próxima Cobrança
post
Carteiras de Cobrança
Criar Carteira de Cobrança
post
Listar Carteiras
get
Informações da Carteira
get
Atualizar a Carteira
put
Solicitar Homologação da Carteira de Cobrança
get
Validar Carteira de Cobrança
put
Alterar Carteira de Cobrança padrão
put
Outros Recursos
Eventos
Listar Eventos
get
Informações do Evento
get
Histórico de SMS
Listar SMS Enviados
get
Informações do SMS Enviado
get
Reenviar SMS Enviado
put
Webhooks
Criar Webhook
post
Listar Webhooks
get
Informações do Webhook
get
Atualizar Webhook
put
Excluir Webhook
delete
Histórico de E-mails
Listar E-mails Enviados
get
Informações do E-mail Enviado
get
Reenviar E-mail Enviado
put
Usuário Autenticado
Informações do Usuário
get
Log de Webhooks
Listar Webhooks Enviados
get
Informações do Webhook Enviado
get
Reenviar Webhooks Enviados
put
Recursos
CNAB (Retorno)
Enviar CNAB
post
Listar CNABs
get
Informações do CNAB
get
Quitar Boletos
put
Reprocessar CNAB
put
Download do CNAB
get
Exportação do Lote
Arquivo de Exportação do Lote
get
Lotes
Criar Lote
post
Listar Lotes
get
Informações do Lote
get
Excluir o lote
delete
Incluir Boletos no Lote
put
Excluir Boleto do Lote
delete
Exportar Lote no Formato .zip
post
Exportar Lote no Formato .pdf
post
Registro de Retorno
Listar Registros de Retorno
get
Informações do Registro de Retorno
get
Recebimento de Boleto
Efetuar Pagamento de Boleto
post
Listar Pagamentos de Boleto
get
Informações do Pagamento de Boleto
get
Excluir Pagamento de Boleto
delete
Registro de Boleto
Listar Registros de Boleto.
get
Informações do Registro de Boleto
get
Registro de Remessa
Listar Registros de Remessa
get
Listar Registros de Remessa Pendentes
get
Criar Pendências
post
Excluir Pendências
delete
Informações do Registro de Remessa
get
Importações
Listar Importações
get
Importar
post
Visualizar Importação
get
CNAB (Remessa)
Criar CNAB
post
Listar CNABs
get
Informações do CNAB
get
Apagar CNAB
delete
Raw(text/plain) do CNAB
get
Criar CNABs em Lote
post
Relatórios
Contagem de Boletos.
get
Novas APIs
Pix
Webhooks
Webhooks
Eventos
Configuração
Notificações
Segurança
Payloads
Criar um Cliente
post
https://{apiHost}/v1/customers
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
Log in to use your API keys
URL
Base URL
https://
api-sandbox.kobana.com.br
/v1/customers
RESPONSE
Click
Try It!
to start a request and see the response here!
