For AI agents: visit https://developers.celcoin.com.br/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Documentação
Recipes
API
Ask AI
v2.0.0
v2.0.1
Status Page
Suporte
Documentação
Search
Status Page
Suporte
v2.0.0
Documentação
Recipes
API
Ask AI
Campos da Pessoa
Introdução
Credenciais de acesso
Segurança da API
Idempotência das APIs
Certificado mTLS
Controle de taxa (rate-control)
Faça sua primeira consulta
Arquivo de movimentação via SFTP
Servidor MCP da Celcoin
Homologação
Instruções para homologar
Produtos de Autenticação
Fluxo de Assinaturas (Docsign)
Autenticação Biométrica
cel_banking - BaaS & Core
Sobre o BaaS & Core Banking
FAQs
Diretriz Termos de Uso - BaaS
Follow the Money (Antifraude e PLD)
APP e Internet Banking Whitelabel (MyBenk)
Painel do Cliente (contratante do BaaS ou Core)
Abertura de Contas (KYC)
Criação de Contas (Onboarding)
Informações financeiras
Webhooks Onboarding
BC Protege+
Cenários práticos - Abertura de Conta PJ
Onboarding Sem Webview
Cenários práticos - Abertura de Conta PJ
FAQs
Gestão de Contas
Criar Conta - Apenas Core Banking
Informações financeiras
Atualizar Dados do Cliente
Desativar / Encerrar uma Conta
Listar Contas
Tabela de erros Gestão de Contas
Número de contas
Bloqueios Judiciais
Atualização de Status de Conta
Adicionar Saldo (em sandbox)
Monitoramento cadastral
Webhooks - Monitoramento cadastral
Simulação de Monitoramento Cadastral
Relatórios
Consultar Saldo
Saldo Dia & Movimentações Diárias Consolidadas
Consultar Extrato
Consultar Extrato Detalhado
Pix
Sobre o Pix
Implantação
Receber via Pix (Cash-in)
Receber um Pix Cash-in por Agência e Conta
Receber um Pix Cash-in por Chave Aleatória
Receber um Pix Cash-in por Chaves Individualizadas
Receber um Pix Cash-in por Cobrança estática
Receber um Pix Cash-in por QR Code dinâmico (immediate)
Receber um Pix Cash-in por QR Code dinâmico(duedate)
Bloqueio Cautelar - Recebimento Pix
Consulta de recebimentos Pix
Devolver um Pix Cash-in
Modelo Webhook
Split - Recebimento de Pix
Split de Pix Cash-in por QR Code dinâmico(duedate)
Split de Pix Cash-in por QR Code dinâmico (immediate)
Pagamento via Pix (Cash-out)
Boas Práticas - Consumo da API de Consulta DICT
Consultar Chaves Pix Externa (DICT)
Realizar um Pix Cash-Out por Agência e Conta
Realizar um Pix Cash-Out por Chaves Pix
Realizar um Pix Cash-Out por QR Code Estático
Realizar um Pix Cash-Out por QR Code Dinâmico
Consultar transferências, pagamentos e devoluções de Pix-Out
Tabela de erros Cash-Out
Modelo Webhook
Bloqueio Cautelar - Envio Pix
Gerenciamento de Chaves
Cadastrar uma Chave Pix
Excluir Chaves Pix de uma Conta
Consultar Chaves Pix de uma Conta
Alteração de nome em uma chave Pix
Tabela de erros Gerenciamento de Chaves (DICT)
Portabilidade e Reivindicação de Chaves
Primeiros passos para Portabilidade e Reivindicação de Chaves Pix
Solicitar Portabilidade de Chave Pix
Responder Portabilidade de Chave Pix
Consultar pedidos de Portabilidade ou Reivindicação
Tabela de erros portabilidade PIX
Pix -> Devolução de Recebimentos Pix
Realizar uma Devolução de Recebimento Pix
Consultar o Status de uma Devolução de Recebimento Pix
Tabela de erros Pix devolução
Agendador de Transação Pix
Agendar uma transação Pix
Consultar Pix agendado
Cancelar um Pix agendado
Consultar Lista de Transações agendadas
MED 2.0
Abertura de MED pelo cliente Celcoin
Criar recuperação de valores
Consultar recuperação de valores
Cancelar recuperação de valores
Recebimento de valores
Recebimento de MED pelo cliente Celcoin
Receber uma recuperação de valores
Bloqueio de valores
Desbloqueio de valores
Devolução de valores
Webhooks Med 2.0
Pix Automático
Jornada Pagadora
Autorização - Visão Geral
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Agendamento
Liquidação
Cancelamento do Consentimento
Cancelamento de agendamento
Consultas - Visão Pagador
Jornada Recebedora
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Envio de Agendamento
Liquidação
Retentativas de Recebimento
Cancelamento de Agendamento
Cancelamento de Recorrência
Motivos de rejeição pelo participante pagador
FAQ
Pix - Participante Indireto
Sobre o Pix - Participante Indireto
Pré-requisitos do Participante
Fases do processo de adesão do Participante Indireto
DICT (Diretório de Identificadores de Contas Transacionais)
Gestão de Chaves Pix
Portabilidade e Reivindicação
Infrações
Mecanismo Especial de Devoluções (MED)
Emissão de Boletos
Emitir Boleto/Cobrança
Emitir Boleto/Cobrança com Split de Pagamento
Atualizar Boleto
Criar um PDF para uma Cobrança
Consultar Boleto Emitido
Consultar Boletos por Período
Cancelar Boleto Emitido
Pagamento de boletos
Realizar um pagamento de boletos
Consultar Status de uma pagamento de Boleto
Tabela de erros pagamento de contas
Transferência entre contas
Realizar uma transferência entre contas
Consulta status da uma transferência entre contas
Tabela de erros transferência entre conta baas
SLC (domicílio de arranjo de cartões)
Recebimento de liquidações do arranjo de cartões via SLC (Domicílio Bancário)
TED
Recebendo Transferências TED na sua Conta BaaS
Realizar uma Transferência via TED
Consultar status de um transferência TED
Modelos Webhooks
Débito Veicular
Consultar Débitos Veiculares
Efetivar Pagamento de Débitos Veiculares
Débitos Dependentes, Distintos e Obrigatórios
Massa de Testes Débito Veicular
FAQs
Recargas
Consulta de operadoras e valores
Realizar uma recarga
CNAB
Processar, Consultar e Baixar CNAB
Open Finance as a Service
Marcas no Open Finance
Listar marcas no Diretório de Participantes do Open Finance
Obter detalhes de marcas no Open Finance
Uso e disponibilização de logotipos
Termos e Condições de uso
Recepção de Dados
Como funciona consentimento e consumo de dados
Limites de Consumo Operacionais dos dados do Open Finance Brasil
API Resources - Recursos Consentidos
API de Dados Cadastrais
API Cartões de Crédito
API Contas
API Operações de Crédito - Empréstimos
API Operações de Crédito - Financiamento
API Operações de Crédito - Adiantamento a Depositantes
API Operações de Crédito - Direitos Creditórios Descontados
API Investimentos - Renda Fixa Bancária
API Investimentos - Renda Fixa Crédito
API Investimentos - Renda Variável
API Investimentos - Títulos do Tesouro Direto
API Investimentos - Fundos de Investimentos
Códigos de Resposta e Cenários de Erro
Jornada Sem Redirecionamento
Como funciona o Vínculo de Dispositivo da Jornada Sem Redirecionamento
Pagamento
Documentação Técnica - API
Criar Vínculo
Callback do Vínculo
FIDO Registration Options
FIDO Registration
Criar Iniciação de Pagamento - v4
FIDO Sign Options
Autorização FIDO
PIX - v4
Validação da Biometria (FIDO) para o Fluxo da Jornada Sem Redirecionamento
Transferências Inteligentes - Sweeping Accounts
Sweeping Accounts - Criação de Payment Initiation
Sweeping Accounts - Execução de Pagamento Pix
Sweeping Accounts - Consultas
Sweeping Accounts - Cancelamento de Consentimento
Sweeping Accounts - Webhooks
Sweeping Accounts - Máquina de Estados
Pagamento Instantâneo - ITP (Jornada com Redirecionamento)
ITP - Criar Consentimento (Payment Initiation)
ITP - Máquina de Estados - Pagamento ITP
ITP - Callback do Consentimento
ITP - Consultas
ITP - Webhooks
ITP - Códigos de Resposta HTTP
ITP - Possíveis Erros de Pagamento
Pagamentos Automáticos
Criar Consentimento Recorrente
Jornada de Autorização
Callback e Execução de Pagamento Automático
Retentativas Intradia e Extradia
Consulta e Cancelamento
Webhooks - Pagamento Automático
Máquina de Estados - Pagamento Automático
Detentora de Contas - Ambiente Sandbox
Massa de Testes para Jornadas de Pagamento
Validar SUCESSO no valor máximo dentro do permitido no vínculo do pix
Validar SUCESSO no valor máximo dentro do permitido no vínculo do pix e no limite diário
Validar FALHA no valor que excede o limite
Validar FALHA por saldo insuficiente
Validar qual erro prevalece quando ambas as condições, valor limite excedido e saldo insuficiente, falham
Validar FALHA por exceder o limite diário configurado pelo cliente
Validar FALHA por exceder o limite noturno
Validar FALHA quando o consentimento (autorização do cliente) está EXPIRADO
Validar FALHA quando o consentimento é REVOGADO pelo cliente na Instituição Detentora
Validar FALHA se o vínculo for REJEITADO por tempo limite de espera
Subadquirência e AaaS (Acquiring as a Service)
Credenciamento na Subadquirência
Consultar Status do Credenciamento da Conta
Reenvio do Credenciamento da Subconta
Clientes
Criar Cliente
Listar Clientes
Editar Cliente
Excluir Cliente
Cartões
Criar Cartão
Listar Cartões
Inativar Cartão
Cobrança Avulsa no Cartão de Crédito
Criar Cobrança Avulsa
Listar Cobranças Avulsas
Editar Cobrança Avulsa
Retentar Cobrança Avulsa
Estornar Cobrança Avulsa
Cancelar Cobrança Avulsa
Capturar Cobrança no Cartão
Gestão de Recebíveis
Solicitar Relatório de Recebíveis
Fazer o Download do Relatório de Recebíveis
Listar Solicitações de Relatórios de Recebíveis
Antecipação Pontual de Recebíveis
Consulta de Valores e Recebíveis Elegíveis à Antecipação Pontual
Simular Antecipação de Recebíveis
Efetiva a Antecipação dos Recebíveis
Lista Simulações de Antecipação Realizadas
Consulta Detalhes de Antecipação
Planos
Criar Plano
Listar Planos
Editar Plano
Excluir Plano
Assinaturas e Contratos
Criar Assinatura com ou sem plano
Criar Assinatura/Contrato Manual
Listar Assinaturas/contratos
Adicionar Transação
Editar Informações da Assinatura/Contrato
Editar Pagamento da Assinatura/Contrato
Editar Transação
Retentar Cobrança no Cartão
Capturar cobrança no cartão
Estornar Cobrança no Cartão
Cancelar Assinatura/Contrato
Cancelar uma Transação
Disputas e Chargebacks
Listar Chargebacks
Enviar Documentação de Defesa do Chargeback
Desistir da Disputa dos Chargeback
Cadastrar Webhooks de Chargeback
Simular Fluxo Chargeback Sandbox
Webhooks
Tokenização de Cartão via JS
Taxas
Listar Taxas
Transações
Listar Transações
Extrato de Recebíveis
Autenticação 3DS
Informe de Rendimentos
Informe de Rendimentos PF
Informe de Rendimentos PJ
Webhooks
Cadastrar e Gerenciar Webhooks
Reenvio de Webhook
Templates de Webhooks do BaaS
Bloqueio/desbloqueio de saldo por infração
Tabela de erros BaaS
Core Banking - Lançamento manual
Realizar lançamento manual
Consultar tipos de lançamento
Core Banking - Bloqueio e Desbloqueio de Saldo
Bloqueio de saldo
Desbloqueio de saldo
Cenários práticos
cel_banking - cards
Sobre cel_card
Gestão de Conta Cartão
Criar uma Conta Cartão (Onboarding)
Consultando dados de uma Conta Cartão
Limites da Conta Cartão
Atualizar Dados Cadastrais da Conta Cartão
Atualização de telefone
Cancelamento de conta e cartão
Endereços
Gestão de Cartões
Emissão de Cartões
Emissão/Geração de Cartão
Emissão de 2ª via de cartão
Rastreio de Cartões
Consulta de rastreio
Simulação de Rastreio do Cartão
Ativação de Cartão
Alteração de status
Visualização dos dados do cartão
Listagem de Cartões
Configuração de contactless (NFC)
Gestão de senha
Alteração de Senha do Cartão - Pin Online e Pin Offline
Simulador de Transações
Webhooks
Cadastrar e Gerenciar Webhooks
Template de Webhooks
Reenvio de Webhook Pendente
cel_credit
Visão Geral
Autenticação
Variáveis Personalizadas
Solicitações
Campos de Solicitação
Simulações
Status de Solicitação
Tabela de Erros de Geração de Boleto
Assinatura
Modalidades
Assinatura via Cláusula Mandato (Timestamp)
Assinatura via Envio de PDF
Consulta de Assinaturas da CCB
Webhooks
Consignado Crédito Trabalhador
Modalidade sem Leilão
Solicitação & Consentimento do Tomador
Consulta de Margem & Simulação de Crédito
Consulta de Saldo FGTS & Multa Rescisória FGTS
Cadastro do Tomador, Emissão & Cancelamento
Guia rápido consignado
Falhas de Averbação – Integração Dataprev
Status da Operação
Consultas, Escriturações e Repasses
Consulta Status da Garantia da Operação
Empréstimo Consignado Servidores do Exército
Autenticação
Consulta de margem
Simulação da CCB
Criação do tomador
Compra com troco
Status da Operação
Portabilidade de Crédito
Portabilidade de Crédito do Trabalhador
Portabilidade no ambiente do originador
Simulação de portabilidade de crédito do trabalhador
Autorização de consulta & consulta de vículo empregatício
Cadastro do tomador & emissão da CCB de portabilidade
Proposta de portabilidade e resposta a proposta
Averbação por portabilidade & envio de contrato
Conta escrow
Onboarding conta escrow
Fluxo essencial
Depósitos
Destinatários e Cobranças (Charges)
Permissões
cel_banking - embedded solutions
Conta Celcoin
DDA
Sobre DDA
Tabela de erros
FAQs
Débitos Veiculares
Sobre a API de Débito Veicular
Enriquecimento de Placas
Débitos Dependentes, Distintos e Obrigatórios
Cadastro de Webhook com Autenticação Via Token - JWT
Idempotencia
Tabela de erros
Massa de Testes Débito Veicular
FAQs
Emissão de Nota Fiscal de Serviço (NFs-e)
Sobre a API de Emissão de Nota Fiscal de Serviços (NFs-e)
Tabela de Erros
Emissão de Boletos - Conta Única (Direto)
Gestão de Beneficiários
Gestão de Carteiras
Gestão de Emissão de Boletos
Gestão de Baixa de Boletos
Tabelas de Erros - Emissão Celcoin
Pagamento de contas
Sobre as APIs de Pagamento de Contas
Devolução de pagamento de conta
Massa de dados para testes
Tabelas de erros das APIs
Lista de Convênios
FAQs
Pix
Pix - Avulso
Recargas
Sobre recargas nacionais
Termos de uso
FAQs
Saques e depósitos físicos
Sobre Saques e depósitos
TED
Sobre as transferências via TED
Tabela de erros ao realizar uma TED
Conciliação
APIs para Conciliação
SLC (Celcoin como Banco Liquidante)
Pix - Participante Indireto Avulso
Sobre o Participante Indireto
Introdução
Pré-requisitos do Participante
Fases do processo de adesão do Participante Indireto
DICT (Diretório de Identificadores de Contas Transacionais)
Gestão de Chaves Pix
Listar todas as chaves pix de um cliente
Portabilidade e Reivindicação
Infrações e MED
Infrações
Mecanismo Especial de Devoluções (MED)
Marcação de fraude
MED 2.0
Criação recuperação de valores
Consulta recuperação de valores
Cancela recuperação de valores
Cria solicitação de devolução em recuperação de valores
Consulta grafo de recuperação de valores
Atualizar a recuperação de valores
Status da Recuperação de Valores
Fechar uma Recuperação de valores
Fechar devolução em recuperação de valores
Autorização do CashIn
Autorização
QR Code
Receber com Pix (Pix Cash-in Indireto)
Transferências
Pagamentos (Pix cash-out para Indiretos)
Recebimentos (Pix Cashin)
Devolução de recebimentos Pix
Transações fora do SPI - Reporte Bacen
Pix Saque/Troco
Tabela de erros para participantes Indiretos do Pix
Pix Automático
Jornada Pagadora
Autorização - Visão Geral
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Agendamento
Liquidação
Cancelamento do Consentimento
Cancelamento de agendamento
Consultas - Visão Pagador
Jornada Recebedora
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Envio de Agendamento
Liquidação
Retentativas de Recebimento
Cancelamento de Agendamento
Cancelamento de Recorrência
Webhooks
Modelos de webhooks do Participante Indireto Pix
Download de Certificados de QR Code Pix
CEL_BRICKS WEBHOOKS
Webhook Manager
Cadastrar e Gerenciar Webhooks
Reenvio de Webhook
cel_open
Compartilhamento de Dados
Etapa 1: Consentimento
Etapa 2: Direcionamento
Etapa 3: Autenticação
Etapa 4: Confirmação
Etapa 5: Redirecionamento
Documentação Técnica: Transmissora
Documentação Técnica: Receptora
Jornada Com redirecionamento
Documentação Técnica - API
Criar Iniciação de Pagamento - v4
Criar Iniciação de Pagamento - v5
Callback da Iniciação de Pagamento
PIX - v4
PIX - v5
Documentação Técnica - WL
Criar Jornada de Pagamento - v4
Criar Jornada de Pagamento - v5
Listar Jornadas de Pagamento - v4
Listar Jornadas de Pagamento - v5
Buscar Jornada de Pagamento - v4
Buscar Jornada de Pagamento - v5
Jornada Sem Redirecionamento
Criar vínculo
Pagamento
Documentação Técnica - API
Criar Vínculo
Callback do Vínculo
FIDO Registration Options
FIDO Registration
Criar Iniciação de Pagamento - v4
Criar Iniciação de Pagamento - v5
FIDO Sign Options
Autorização FIDO
PIX - v4
PIX - v5
Documentação Técnica - WL
Criar Jornada de Vínculo
Listar Jornadas de Vínculo
Buscar Jornada de Vínculo
Criar Jornada de Pagamento - v4
Criar Jornada de Pagamento - v5
Listar Jornadas de Pagamento - v4
Listar Jornadas de Pagamento - v5
Buscar Jornada de Pagamento - v4
Buscar Jornada de Pagamento - v5
Brick Bank
Receptora de Dados
Transmissora de Dados
Detentora de Contas
Brick Insurance
Receptora de Dados (Open Insurance)
Transmissora de Dados (Open Insurance)
Open Plus
Portal
Cadastro e acesso
Hall Open Plus
Gestão de aplicações
Catálogo de produtos
Gestão de membros da equipe
Menu de usuário
Painel de gestão da aplicação
Painel de gestão do produto
Documentação de produto
Credenciais e usuário de teste
Subir em produção
Portal Configurações
Plataforma de Iniciação (ITP)
Portal de configurações do Open Keys
Dashboard
Lista de Transações
Lista de Vínculos de Conta
Relatórios
Configurações da jornada de pagamentos
Demo das Jornadas de Pagamento
Demo da Área de Gestão
Jornadas White Label
Iniciação de Pagamento Instantâneo
Gestão de Pagamentos Instantâneos
Iniciação de Pagamento Agendado
Gestão de Pagamentos Agendados
Iniciação de Pagamento sem Redirecionamento
Gestão de Contas Salvas (Vínculos)
Iniciação de Pagamento Automático
Gestão de Pagamentos Automáticos
FAQ Open Keys
Jornada Pay by Link
Pagamento por Aproximação
Documentação técnica
Status e respostas: Máquina de estados
Status e respostas: Códigos de resposta HTTP
Status e respostas: Possíveis erros de pagamentos
Diagrama de sequência: Jornada com Redirecionamento
Diagrama de sequência: Jornada sem Redirecionamento
Webhook
APIs
Transferências inteligentes (Sweeping Accounts)
Criar consentimento
Callback do Consentimento
Cancelamento de consentimento
Listar Consentimentos
Buscar informações de um consentimento
Criação de uma sessão de jornada
Listar sessões de jornada
Buscar informações de uma sessão de jornada
Transferências Inteligentes
Migração da API de Pagamentos V4 para V5
Pix - Integração Avulsa
Sobre o Pix
Receber com Pix (cash-in)
Cobrança imediata com QR Code dinâmico (immediate)
Cobrança com vencimento com QR Code dinâmico (duedate)
Cobrança estática
Consulta de recebimentos Pix
Devolução de recebimentos Pix
Transferências e pagamentos com Pix (cash-out)
DICT
Balde de Fichas
Transferência Pix a partir de dados bancários
Transferência Pix a partir de uma chave
Pagamento de um QR Code Estático
Pagamento de um QR Code Dinâmico
Pix entre contas (Pix Interno)
Consultar transferências, pagamentos e devoluções de Pix-Out
Pagamento de um QR Code (estático ou dinâmico)
Pix Automático
Jornada Pagadora
Autorização - Visão Geral
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Agendamento
Liquidação
Cancelamento do Consentimento
Cancelamento de agendamento
Consultas - Visão Pagador
Jornada Recebedora
Autorização - Jornada 1
Autorização - Jornada 2
Autorização - Jornada 3
Autorização - Jornada 4
Envio de Agendamento
Cancelamento de Agendamento
Cancelamento de Recorrência
Liquidação
Retentativas de Recebimento
Tabela de erros Pix
FAQs
Webhook
Modelos Template de webhooks do Pix
Conciliação
API para Conciliação
Sobre API de Conciliação
API para Extrato Consolidado
Sobre API de Extrato Consolidado
Tabela de Erros
Suporte
Central de ajuda
SLA de atendimento
PAINEL DO CLIENTE
Listagem de Tickets
ANTI-FRAUDES
Follow the Money
Validação AntiFraude Pix
Powered by
Campos da Pessoa
Copy Page
