Jump to Content
Documentação
Recipes
API
Changelog
v2.0.0
v2.0.1
Documentação
API
Status
Suporte
FAQs
celcoin.com
Log In
API
Search
Documentação
API
Status
Suporte
FAQs
celcoin.com
Log In
v2.0.0
Documentação
Recipes
API
Changelog
Cadastro de Webhooks
All
Pages
Start typing to search…
JUMP TO
Celcoin Infratech API
Integrando na Celcoin
Token
Gera o token para autenticação dos endpoints da API.
post
CEL_ONBOARDING
Onboarding
Criar proposta Pessoa Física.
post
Criar proposta Pessoa Jurídica.
post
Buscar uma proposta ou uma lista de propostas.
get
Busca um arquivo ou uma lista de arquivos.
get
Busca tagueamento da jornada do webview.
get
EMBEDDED PAYMENT
APIs auxiliares
Retornar informações do seu saldo atual
get
Recuperar detalhes de uma transação
get
Obter comprovante de uma transação
get
Listar convênios
get
Retorna a saúde de um determinado tipo de transação
get
Listar bancos
get
Listar transações pendentes
get
APIs de Extrato
Consultar extrato consolidado
get
Arquivos de Conciliação
Buscar tipos de arquivos
get
Extrair arquivo
get
Extrato consolidado
get
DDA
Webhooks
Configurar webhooks
post
Consultar webhooks
get
Usuários
Cadastrar usuário
post
Excluir usuário
del
Boletos (Apenas sandbox)
Gerar boleto
post
Débitos Veiculares
Consulta
Consultar Débitos de um veículo
post
Enriquecimento de Placas
Consultar Dados Enriquecidos de um Veículo
post
Pagamento
Realizar pagamento
post
Webhook
Registrar URL para recebimento de notificações via Webhook
post
Registrar Webhook Com Token - JWT
post
Retornar URL registrada para recebimento de notificações via Webhook
get
Emissão de Boletos
Gestão de Carteiras
Inclusão de Carteira
post
Consulta de Carteira por código/ID
get
Alteração de Carteira
patch
Exclusão de carteira
del
Consulta de todas as Carteiras
get
Gestão de Beneficiários
Inclusão de Beneficiário
post
Consulta de Beneficiário
get
Gestão de Boletos
Emissão de Boleto
post
Consulta de boletos com paginação
get
Consulta de boleto por Id
get
Gestão de Baixas
Inclusão de Baixa (Cancelamento)
post
Consulta de Baixa
get
Pagamento de contas
Consultar os dados de uma conta
post
Reservar saldo para efetuar o pagamento de uma conta
post
Confirmar o pagamento de uma conta
put
Consultar status de uma transação
get
Consultar ocorrências de um pagamento
get
Cancelar uma reserva realizada
del
Reverter uma transação de pagamento de contas efetuada
del
Pix Automático
Jornada Pagadora
Aceita uma recorrência
post
Aceita uma recorrência
patch
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
get
Jornada Recebedora
Crie uma recorrência com a jornada 1
post
Crie uma recorrência com a jornada 2
post
Pix-in
Cobrança dinâmica (dynamic)
Criar um QR Code dinâmico
post
Buscar dados de uma cobrança dinâmica
get
Atualizar QR Code dinâmico
put
Recupera uma imagem base64 representando um QR Code dinâmico
get
Carrega, valida e parseia o json do payload da URL
post
Deletar um QR Code dinâmico
del
Cobrança estática
Criar um QR Code estático
post
Retornar dados de um QR Code estático.
get
Recupera uma imagem base64 representando um QR Code estático
get
Retornar dados do QR Code estático e os pagamentos recebidos
get
Deleta um QR code estático
del
QR Code (Location)
Criar um QR Code (location)
post
Retorna os dados de um QR Code location
get
Recupera uma imagem base64 representando um QR Code Location dinâmico
get
Cobrança imediata (COB)
Criar nova cobrança imediata
post
Atualizar dados de uma cobrança imediata
put
Busca de dados de uma cobrança imediata
get
Desvincular cobrança imediata de um BRCode Location
patch
Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)
get
Deletar uma cobrança imediata
del
Cobrança com vencimento (COBV)
Criar cobrança com vencimento
post
Atualizar dados de uma cobrança com vencimento
put
Buscar dados de uma cobrança com vencimento
get
Desvincular cobrança com vencimento de um QR Code location
patch
Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)
get
Deletar uma cobrança com vencimento
del
Recebimentos Pix
Consulta o status de um Recebimento Pix
get
Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)
get
Devolução de cash-in
Criar uma devolução de um recebimento Pix
post
Consulta o status de uma devolução de recebimento Pix criada
get
Pix-out
DICT (Diretório de Identificadores de Contas Transacionais)
Retornar informações do DICT utilizando uma chave cadastrada no Pix
post
Realizar busca das estatísticas de chave ou de pessoa
get
Participante
Listar participantes do Pix
get
Pagamento com Pix
Iniciar pagamento Pix
post
Verificar o status de um pagamento Pix
get
Verificar o status de um pagamento Pix - Versão Enriquecida (V2)
get
Retornar informações de um QRCode pelo EMV
post
Devolução de cash-out
Consulta uma devolução de pagamento Pix recebida
get
ITP (Iniciação de Transação de Pagamento)
Criar um Pix ITP
post
Criar Setup de um Pix ITP
post
Editar Setup de um Pix ITP
put
Recargas
Listar operadoras
get
Consultar valores operacionais para uma operadora ou provedor
get
Reservar saldo para realizar recarga
post
Confirmar a transação de uma recarga
put
Consultar informações de uma recarga
get
Cancelar transação de recarga efetuada
del
Buscar operadora a partir de um número de telefone
get
Saques e depósitos físicos
Retornar lista de Parceiros
get
Consultar pontos de atendimentos próximos
post
Realizar depósito em um caixa 24h
post
Efetuar saque eletrônico com Qrcode
post
Gerar token para saque no caixa 24h
post
Cancela um token para saque no caixa 24h
del
TED
Realizar TED
post
Verificar status de uma TED
get
Cadastro de Webhooks
cel_banking - BaaS
Gestão de Contas
Criação de contas
Abertura de conta e KYC
Verificar Status da Conta.
get
Atualizar dados do Cliente PF
put
Atualizar dados do Cliente PJ
put
Retorna informações de conta PF
get
Retorna informações de conta PJ
get
Retorna informações de varias contas PF
get
Retorna informações de varias contas PJ
get
Altera status da conta
put
Encerra conta
del
Criação de contas V1 (Descontinuado)
Criar Conta PJ
post
Criar Conta PF
post
Informação das Contas
Consultar Saldo
get
Consultar Saldo do Dia
get
Consultar Extrato
get
Consultar Transações do Extrato
get
Consultar Extrato Detalhado (Beta)
get
Transferência entre contas
Inicia uma transferência entre contas
post
Consultar status de uma transferência interna
get
Pix
Pagamento (cash-out)
Consulta EMV QRCode
Consultar uma chave Pix (DICT)
get
Pix Cashout
post
Verificar Status do PIX
get
Participantes PIX
get
Recebimento (cash-in)
Criação de QRCode
Consulta status de QRCode
Consulta de recebimentos Pix
Devolução de cash-in
Iniciar a Devolução de um Recebimento Pix
post
Consultar o Status de uma Devolução de Recebimento Pix
get
Devolução de cash-out
Consultar uma devolução de Pix-out
Gerenciamento de Chaves
Criar chaves Pix
post
Consultar chaves Pix de uma conta
get
Excluir chaves Pix
del
Portabilidade e Reivindicação de Chaves Pix
Cadastra nova reivindicação/portabilidade de chave Pix
post
Confirma nova reivindicação/portabilidade de chave Pix
post
Cancela nova reivindicação/portabilidade de chave Pix
post
Consulta reivindicação/portabilidade de chave Pix
get
Consulta lista de reivindicação/portabilidade de chave Pix
get
Split Pix
Split de Pix Cash-in por QR Code dinâmico(duedate)
post
Split de Pix Cash-in por QR Code dinâmico (immediate)
post
Pix Automático
Jornada Pagadora
Aceita uma recorrência Jornada 1
patch
Aceita uma recorrência jornada 2
post
Aceita uma recorrência Jornada 3
post
Aceita uma recorrência jornada 4
post
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
post
Jornada Recebedora
Crie uma recorrência com jornada 1
post
Crie uma recorrência com a jornada 2
post
Crie uma recorrência jornada 3
post
Crie uma recorrência jornada 4
post
Envio de agendamento
put
Retentativas de recebimento
post
Cancelamento de agendamento
post
Cancelamento da recorrência
post
Agendador de Transação
Consultar agendamento de pix
get
Cancelar agendamento de pix
del
Endpoint responsável por listar agendamentos
get
TED
Enviar uma TED
post
Consultar Status de uma transferência TED
get
Emissão de boletos
Emitir Boleto
post
Consultar Boleto Emitido
get
Consulta de Boletos por Período (BETA)
get
Cancelar Boleto Emitido
del
Gerar PDF para um Boleto Emitido
get
Pagamento de Contas
Pagamento de conta.
post
Status de um Pagamento de conta.
get
Recargas
Realizar Recarga
post
Consultar Recarga
get
Débitos Veiculares
Criar pedido de consulta de débitos veiculares.
post
Consultar pedido de consulta de débitos veiculares.
get
Realizar pagamento de Débito Veicular
post
Consultar pagamento e débitos veiculares.
get
Informe de Rendimentos
Consultar Informe de Rendimentos
get
Gerenciamento de Webhook
Cadastrar Webhook
post
Consultar Webhooks cadastrados
get
Editar Webhook cadastrado
put
Excluir Webhook cadastrado
del
Consultar lista de eventos enviados pelo webhook
get
Consultar Templates de Webhooks
get
Consultar quantidade de webhooks enviados.
get
Consultar detalhes dos webhooks enviados.
get
Reenvio de webhooks pendentes
put
BAAS ITP V2
Contas de crédito da Aplicação
Criar conta de crédito
post
Listar contas de crédito
get
Buscar dados de uma conta de crédito
get
Deletar uma conta de crédito
del
URL de redirecionamentos da Aplicação
Adicionar URL de redirecionamento
post
Listar URLs de redirecionamento
get
Buscar dados de uma URL de redirecionamento
get
Deletar URL de redirecionamento
del
Webhooks da Aplicação
Cadastrar webhook da aplicação
post
Obter .
get
Obter .
get
Obter .
del
Configuração da Aplicação
Criar ou atualizar configuração da aplicação
post
Obtain .
get
Participants
Lista as detentoras participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Sessão de jornadas
Criar uma sessão de jornada ITP
post
Listar sessões de jornada
get
Buscar dados de uma sessão de jornada
get
Enrollment Journey Sessions
Creates an ITP journey session for enrollment.
post
Lists enrollment journey sessions.
get
Search for an enrollment journey session.
get
Updates the enrollment journey session.
patch
Search for an enrollment journey session, using as reference the external ID sent in the creation of the session.
get
Enrollment Payment Initiation
Creates an enrollment payment initiation.
post
Lists enrollment payment initiations.
get
Gets an enrollment payment initiation.
get
Updates an enrollment payment initiation.
patch
Gets enrollment FIDO registration options.
post
Completes enrollment FIDO registration.
post
Gets enrollment FIDO sign options.
post
Authorizes enrollment consent.
post
Payment Initiation
Payment Processing.
post
Payment Processing.
get
Payment Initiation Management Session
Create end user managament session with url.
post
Get end user management session data.
get
CNAB
Processamento de Arquivo CNAB
post
Consulta de Dados CNAB enviado
get
Baixar arquivo retorno do CNAB pelo id.
get
Baixar arquivo remessa do CNAB pelo id.
get
CEL_BRICKS WEBHOOKS
Webhook Manager
Cadastrar Webhook
post
Reenvio de webhooks pendentes
put
Consultar detalhes dos webhooks enviados.
get
Consultar quantidade de webhooks enviados.
get
Excluir Webhook cadastrado.
del
Editar Webhook cadastrado.
put
Consultar Webhooks cadastrados.
get
Participante Indireto Pix
Pix Automático
Jornada Pagadora
Aceita uma recorrência
post
Aceita uma recorrência
patch
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
get
Jornada Recebedora
Crie uma recorrência com a jornada 1
post
Crie uma recorrência com a jornada 2
post
Recebimento com Pix
Consulta o status de um Recebimento Pix
get
Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)
get
Pagamento com Pix
Gerar endToEndId para iniciar um pagamento
post
Iniciar pagamento Pix
post
Verificar o status de um pagamento Pix
get
Verificar o status de um pagamento Pix - Versão Enriquecida (V2)
get
Retornar informações do QR Code a partir de um EMV
post
Devolução
Criar devolução (estorno) de um Pix recebido
post
Consulta o status de uma devolução Pix
get
Consulta o status do recebimento de uma Devolução
get
DICT (Diretório de Identificadores de Contas Transacionais)
Cadastro, Consulta e Deleção de chaves
Cadastrar uma nova chave Pix
post
Altera uma chave Pix
put
Retornar informações do DICT utilizando uma chave cadastrada no Pix
post
Verifica a existência de chaves no DICT
post
Deleta uma chave Pix
del
Realizar busca das estatísticas de chave ou de pessoa
get
Listar todas as chaves pix de um cliente
post
Portabilidade e Reivindicação
Cadastra nova portabilidade ou reivindicação DICT
post
Completa a solicitação de portabilidade/reivindicação de uma chave DICT
post
Cancela uma Claim em processo de resolução ou confirmada por expiração
post
Confirma uma Claim em processo de resolução
post
Consulta uma reivindicação existente
get
Lista portabilidades ou reivindicações com paginação
get
Infractions
Criar um relato de infração para uma transação
post
Consultar um relato de Infração para uma transação
get
Cancelar um relato de infração para uma transação
post
Fechar um relato de infração de uma transação
post
Lista infrações para participantes Indiretos
get
Mecanismo Especial de Devolução - MED
Criar solicitação de devolução
post
Consulta a solicitação de uma devolução
get
Cancelar solicitação de devolução
post
Fechar solicitação de devolução
post
Lista solicitações de devolução
get
QR Code
Criar um QR Code (location)
post
Retorna os dados de um QR Code location
get
Deleta um QR code estático
del
Recupera uma imagem base64 representando um QR Code Location dinâmico
get
Cobrança com vencimento (COBV)
Criar cobrança com vencimento
post
Atualizar dados de uma cobrança com vencimento
put
Deletar uma cobrança com vencimento
del
Buscar dados de uma cobrança com vencimento
get
Desvincular cobrança com vencimento de um QR Code location
patch
Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)
get
Cobrança imediata (COB)
Criar nova cobrança imediata
post
Atualizar dados de uma cobrança imediata
put
Deletar uma cobrança imediata
del
Busca de dados de uma cobrança imediata
get
Desvincular cobrança imediata de um BRCode Location
patch
Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)
get
Cobrança dinâmica (dynamic)
Criar um QR Code dinâmico
post
Recupera uma imagem base64 representando um QR Code dinâmico
get
Atualizar QR Code dinâmico
put
Deletar um QR Code dinâmico
del
Carrega, valida e parseia o json do payload da URL
post
Cobrança estática
Criar um QR Code estático
post
Retornar dados de um QR Code estático.
get
Recupera uma imagem base64 representando um QR Code estático
get
Retornar dados do QR Code estático e os pagamentos recebidos
get
Transferência
Transações fora do SPI - Reporte Bacen
post
MED 2.0
Criar recuperação de valores
post
Consulta recuperação de valores
get
Cancelar recuperação de valores
post
Solicitar devolução de recuperação de valores
post
Consulta grafo de recuperação de valores
get
Atualiza recuperação de valores
put
CEL_OPEN
Consentimento
Solicitar consentimento de pagamento
post
Gerar URL de Autorização
get
Login no Detentor de Contas
post
Aprovar Consentimento no Detentor de Contas
post
Callback
post
Geração do Pagamento
Gerar pagamento via Proxy
post
Consultar pagamento via Proxy
get
Gestão de Consentimento de Pagamentos
Consultar Consentimento
get
Lista de Consentimentos Transmitidos
get
CEL_OPEN ITP V2 APIs Only
Participants
List Open Finance Brasil participant institution brands
get
Get Open Finance Brasil participant institution brand by ID
get
JSR Payment Initiation (Journey without Redirection)
Create Open Finance account enrollment for PIX payment initiation
post
List account links (enrollments).
get
Retrieve enrollment payment initiation details with brand and authorization information
get
Get parameters for FIDO2 credential creation.
post
Associate FIDO2 credential to account enrollment.
post
Get parameters for FIDO2 authentication.
post
Authorizes enrollment consent using FIDO2 signature
post
Payment Initiation
Create PIX payment initiation
post
List PIX payment initiations with filters
get
Get PIX payment initiation by ID
get
Decode PIX EMV string
post
Execute PIX payment
post
Process OAuth2 authorization callback from account holder
post
Payment Initiation Management Session
Create payment initiation management session
post
CEL_OPEN ITP v2
Verificação de Saúde
Obter o status do serviço.
get
Gerenciamento de Aplicação
Criar aplicação
post
Listar aplicações
get
Obter detalhes da aplicação
get
Atualizar aplicação
put
Criar sessão de jornada de pagamento
post
Criar sessão de gestão do usuário final
post
Contas da Aplicação
Criar conta credora
post
Listar contas credoras
get
Detalhar conta credora
get
Deletar conta credora
del
Redirecionamentos da Aplicação
Adicionar URL de redirecionamento
post
Listar URLs de redirecionamento
get
Obter URL de redirecionamento
get
Excluir URL de redirecionamento
del
Webhooks da Aplicação
Criar webhook de aplicação
post
Listar webhooks da aplicação
get
Obter webhook da aplicação
get
Remover webhook da aplicação
del
Configurações da Aplicação
Criar ou atualizar configuração de aplicação
post
Listar configurações da aplicação
get
Participantes
Lista as detentoras participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Sessões de Jornada
Cria uma sessão de jornada ITP.
post
Lista as sessões de uma jornada.
get
Busca por uma sessão de uma jornada.
get
Sessões de Jornada JSR (Jornada sem Redirecionamento)
Cria uma sessão de jornada ITP para vínculo.
post
Lista as sessões de jornada de cadastro.
get
Busca por uma sessão de jornada de cadastro.
get
Atualiza a sessão de jornada de vínculo.
patch
Busca por uma sessão de jornada de cadastro, usando como referência o id externo enviado na criação da sessão.
get
Busca por uma sessão de jornada de cadastro com estágio.
get
Verificar se a sessão da jornada de cadastro expirou.
get
Iniciação de Pagamentos JSR (Jornada sem Redirecionamento)
Criar vínculo (link de conta).
post
Listar vínculos de conta (enrollments).
get
Obtém uma iniciação de pagamento de cadastro.
get
Atualiza uma iniciação de pagamentos de vínculo.
patch
Obtém a iniciação de pagamento de cadastro atualizada.
get
Obtém as opções de registro FIDO para cadastro.
post
Completa o registro FIDO de cadastro.
post
Obtém as opções de assinatura FIDO para autenticação.
post
Autoriza o consentimento de cadastro.
post
Iniciação de Pagamento
Processamento de Pagamento.
post
Processamento de Pagamento.
get
Processamento de Pagamento.
get
Processamento de Pagamento.
patch
Processamento de Pagamento.
patch
Sessão de Gerenciamento de Iniciação de Pagamento
Criar sessão de gerenciamento de usuário final com URL.
post
Obter dados da sessão de gerenciamento de usuário final.
get
CEL_OPEN ITP v2 AUTOMATIC PAYMENTS
Consentimento
Cria um consentimento para transações de pagamentos.
post
URL de Autorização - Api simulando Detentora
get
Login - Api simulando Detentora
post
Aprovação do Consentimento - Api simulando Detentora
post
Callback do Consentimento
post
Pagamento
Cria uma transação de pagamento.
post
Gestão
Busca informações de transações de pagamentos.
get
Busca informações de um consentimento.
get
Rejeita ou revoga um consentimento.
patch
Cancelamento do Consentimento
post
CEL_OPEN ITP V2 SWEEPING ACCOUNTS
Consentimento
CEL_CARD - GESTÃO DE CARTÕES
Cards
Busca dados de um cartão
get
Cria cartões de crédito/débito
post
Lista cartões
get
Atualiza dados de um Cartão
patch
Ativa um cartão
put
Bloqueia um cartão
put
Desbloqueia um cartão
put
Cancela um cartão
put
Reemite um cartão
post
Efetua a alteração do pin do cartão
patch
Busca a senha atual do cartão do cliente
get
Busca informações do cartão do cliente
get
Reseta tentativas erradas de senha
post
Reseta o contador de transações do aplicativo (ATC)
post
Embossing
Busca informações de embossing de um cartão
get
Simulação de rastreamento de um cartão
post
Atualiza endereço do embossing de um cartão
patch
Reenvia cartão para embossing
post
CEL_CARD - TRANSAÇÕES
Authorizations
Simula uma transação
post
Executa um chargeback
post
CEL_CARD - GESTÃO DE CONTAS
Customers
Lista todos os clientes de uma conta específica.
get
Obtém um cliente de uma conta específica pelo Documento.
get
Obtém um cliente de uma conta específica pelo ID.
get
Atualiza os dados de um cliente (PF ou PJ)
patch
Accounts
Busca dados de uma conta específica.
get
Busca uma conta pelos parâmetros.
get
Cria uma nova conta
post
Consulta os limites de uma conta específica
get
Atualiza limite de uma conta
patch
Passa conta informada para status cancelada.
post
Passa conta de status cancelada para normal.
post
Atualiza a data de vencimento da fatura
put
Addresses
Cria um novo endereço para uma conta específica
post
Busca um único endereço de uma conta específica.
get
Atualiza os dados de um endereço
patch
Lista todos os endereços de uma conta específica.
get
phones
Cria um novo telefone para uma conta específica
post
Busca de telefones cadastrado pela conta
get
Atualiza um telefone
get
Atualiza um telefone
patch
CEL_CARD - RELATÓRIOS
Authorizations
Obtem detalhes de autorização usando token
get
CEL_CASH - AaaS
Autenticação
Gerar token de autenticação
post
Gestão de Contas
Cadastrar uma conta PF
post
Cadastrar uma conta PJ
post
Gestão de Recebíveis
Solicitar relatório de recebíveis
post
Visualizar recebível de transação
get
Visualizar recebível de contrato
get
Relatórios
Buscar estado de relatório solicitado
get
Visualizar arquivo de relatório
get
Webhooks
Visualizar template de evento de webhook
get
cel_credit - Originador
Introdução
Autenticação
Obter token de autenticação
post
Emissão de CCB com Cessão Pós-Desembolso
Glossário de Termos Técnicos
Pessoas
Baixar o resultado de uma importação em Lote
get
Criar uma pessoa
post
Consultar pessoas cadastradas
get
Consulta de pessoas por ID
get
Atualizar cadastro de Pessoa
put
Criar um novo documento para a Pessoa
post
Consultar os documentos de uma Pessoa
get
Baixar um arquivo de Documento da Pessoa
get
Atualizar um documento já enviado para a Pessoa
put
Excluir um documento da Pessoa
del
Pessoas > Importação em Lote
Importar Pessoas em Lote
post
Consultar importações em Lote de Pessoas
get
Consultar status de uma Importação
get
Pessoas > KYC
Consultar KYC do CPF da Pessoa
get
Consultar KYC do CPF de forma antecipada
post
Pessoas > KYC > Externo
Enviar um KYC externo
post
Pessoas > SCR
Consultar um determinado SCR de uma Pessoa
get
Consultar o SCR da Pessoa
get
Listar as Consultas de SCRs
get
Pessoas > SCR > Termo de Aceite
Consultar o termo de aceite do SCR da Pessoa
get
Criar um termo de aceite SCR para uma Pessoa
post
Empresas
Empresas > KYC
Consultar KYC do CNPJ da Empresa
get
Consultar KYC do CNPJ de forma antecipada
post
Consultar KYC do CNPJ da Empresa
get
Consultar KYC do CNPJ de forma antecipada
post
Empresas > SCR
Consultar o SCR por CNPJ
post
Consultar um determinado SCR de uma Empresa
get
Consultar o SCR da Empresa
get
Listar as Consultas de SCRs da Empresa
get
Consultar o SCR por CNPJ
post
Consultar um determinado SCR de uma Empresa
get
Consultar o SCR da Empresa
get
Listar as Consultas de SCRs da Empresa
get
Empresas > Relacionamentos
Criar Relacionamento Pessoa x Empresa
post
Consultar Relacionamentos da Empresa
get
Atualizar um relacionamento de Pessoa x Empresa
put
Remover Relacionamento Pessoa x Empresa
del
Criar Relacionamento Pessoa x Empresa
post
Consultar Relacionamentos da Empresa
get
Atualizar um relacionamento de Pessoa x Empresa
put
Remover Relacionamento Pessoa x Empresa
del
Criar uma Empresa
post
Listar Empresas cadastradas
get
Consultar Empresa por ID
get
Atualizar dados da Empresa
put
Criar um novo documento para a Empresa
post
Consultar os documentos da Empresa
get
Atualizar um documento já enviado para a Empresa
put
Excluir um documento da Empresa
del
Baixar um arquivo de documento da Empresa
get
Consultar as linhas de crédito da Empresa
get
Consultar as Solicitações da Empresa
get
Empresas > Relacionamentos
Criar Relacionamento Pessoa x Empresa
post
Consultar Relacionamentos da Empresa
get
Atualizar um relacionamento de Pessoa x Empresa
put
Remover Relacionamento Pessoa x Empresa
del
Empresas > KYC
Consultar KYC do CNPJ da Empresa
get
Consultar KYC do CNPJ de forma antecipada
post
Empresas > KYC > Externo
Enviar um KYC externo
post
Empresas > SCR
Consultar o SCR por CNPJ
post
Consultar um determinado SCR de uma Empresa
get
Consultar o SCR da Empresa
get
Listar as Consultas de SCRs da Empresa
get
Empresas > SCR > Termo de Aceite
Consultar o termo de aceite do SCR da Empresa
get
Criar um termo de aceite SCR para uma Empresa
post
Solicitações
Criar uma nova Solicitação
post
Listar as Solicitações realizadas
get
Criar uma Solicitação com Juros pós fixados
post
Consultar uma Solicitação
get
Cancelar uma Solicitação
post
Listar Índices Financeiros
get
Solicitações > Assinaturas
Configurar uma Assinatura
post
Consultar as configurações de Assinatura
get
Enviar uma Assinatura para uma Solicitação (Timestamp)
post
Enviar uma Assinatura física para uma Solicitação (assinatura externa)
post
Consulta de Assinatura e Link para Coleta
get
Solicitações > Simulação
Criar uma simulação para um valor desejado
post
Criar uma simulação dado o valor total das parcelas
post
Criar uma simulação dado o valor da parcela
post
Criar uma simulação dado o valor total financiado
post
Criar uma simulação com juros pós-fixado
post
Solicitações > Contratos
Consultar o Contrato da Solicitação
get
Consultar o Contrato Assinado da Solicitação
get
Solicitações > Tentativas de Desembolso
Iniciar uma nova tentativa de Desembolso
post
Listar as Tentativas de Desembolso para uma Solicitação
get
Consultar uma Tentativa de Desembolso
get
Download do comprovante de desembolso
get
Solicitações > Ordem de Pagamento
Atualizar Ordem de Pagamento na Solicitação
put
Solicitações > Qualificação
Consulta do Qualification ID
get
Aprovação de um Qualification ID
put
Contas Beneficiárias
Listar Contas Beneficiárias
get
Produtos Licenciados
Listar os Produtos Licenciados
get
Consultar um Produto
get
Consultar Campos Personalizáveis do Produto
get
Webhooks
Listar os Webhooks
get
Cadastrar um Webhook
post
Atualizar um Webhook
put
Excluir um Webhook
del
PAINEL DO CLIENTE
Tickets
Listagem de Tickets
get
Emissão de Nota Fiscal de Serviço
Gestão de Empresas
Cadastrar uma Empresa
post
Consultar uma Empresa
get
Cadastrar um Certificado Digital para a Empresa
post
Gestão de Nota Fiscal
Emitir Nota Fiscal de Serviço
post
Consultar Nota Fiscal de Serviço
get
Cancelar emissão de Nota Fiscal de Serviço
post
Celcoin - Escrow
Introdução
Autenticação
Obter token de autenticação
post
Pessoas
Upload de Documentos da Pessoa
post
Criar uma pessoa do tipo "física"
post
Criar uma pessoa do tipo "jurídica"
post
Listar as pessoas cadastradas
get
Atualizar cadastro da pessoa
patch
Contas
Criar uma nova conta
post
Listas todas as contas cadastradas
get
Consultar os detalhes de uma conta escrow
get
Consultar o extrato da conta
get
Consultar o status/detalhamento de uma transação
get
Contas > Retenção
Cadastrar uma retenção
post
Listar todas as retenções cadastradas
get
Alterar uma retenção
patch
Excluir uma retenção
del
Contas > Webhook
Listar todas as entidades de webhooks disponíveis para configuração
get
Criar uma configuração de webhook
post
Listar todos os webhooks cadastrados para uma Conta
get
Alterar uma configuração de webhook
patch
Excluir uma configuração de webhook
del
Contas > Conta destino
Criar uma nova conta de destino (transferências)
post
Excluir uma conta de destino
del
Alterar uma conta de destino
patch
Solicitações
Criar uma solicitação/transação
post
Listar todas as solicitações
get
Consultar os detalhes de uma solicitação realizada
get
Revisar uma solicitação
put
Cancelar uma solicitação
put
Consultar os detalhes de um código de barras de um boleto
get
Carteiras
Cadastrar uma nova carteira
post
Listar todas as carteiras
get
Consultar os detalhes de uma carteira
get
Alterar os dados de uma carteira
patch
Arquivar ou desarquivar uma carteira
put
Carteiras > Cobranças
Cadastrar uma nova cobrança
post
Listar todas as cobranças de uma carteira
get
Consultar os detalhes de uma cobrança
get
Excluir uma cobrança
del
Baixar o PDF de uma cobrança
get
BaaS API ITP v2
Healthcheck
Obter o status do serviço.
get
Payments v4 - Journey Session
Cria uma sessão de jornada ITP.
post
Lista as sessões de uma jornada.
get
Atualiza a sessão de uma jornada.
put
Busca por uma sessão de uma jornada.
get
Atualiza a sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
put
Busca por uma sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
get
Enrollments v2 - Journey Session
Cria uma sessão de jornada de vínculo.
post
Lista as sessões de uma jornada de vínculo.
get
Busca por uma sessão de uma jornada.
get
Busca por uma sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
get
Automatic Payments v1 - Journey Session
Cria uma sessão de jornada ITP.
post
Lista as sessões de uma jornada.
get
Atualiza a sessão de uma jornada.
put
Busca por uma sessão de uma jornada.
get
Atualiza a sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
put
Busca por uma sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
get
Automatic Payments v1 - Payment Initiation
Cria um consentimento do ITP.
post
Lista os consentimentos.
get
Cancela um consentimento.
patch
Obtem o detalhe de um consentimento.
get
Cancela o Pix.
patch
Cria uma transação de pagamento.
post
Participantes
Lista as detentoras participantes do ITP.
get
Lista as organizações participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Obtém os detalhes de uma organização participante do ITP.
get
End User Management Session
Cria uma sessão de gerenciamento de usuário final com URL.
post
Journey
Lista as jornadas disponíveis.
get
Obtém os detalhes de uma jornada.
get
pix-dict-med-webservice
Mecanismo Especial de Devolução - MED
Powered by
EMBEDDED PAYMENT
Cadastro de Webhooks
Ask AI
