# Celcoin - Infraestrutura de Tecnologia Financeira - Banking, Payments e Credit Documentation > Oferecemos uma infraestrutura completa e pioneira para conectar empresas de todos os segmentos a oportunidades do mercado financeiro, com soluções incorporadas às necessidades de seus clientes. A partir de um novo conceito de Embedded Finance, tudo é feito de uma forma simples, rápida e sem burocracias, deixando toda a parte regulatória com a gente. Isso é Celcoin. The best service for growth. Append .md to any documentation page URL to get its markdown version. ## Guides - [Uma breve introdução](https://developers.celcoin.com.br/docs/bem-vindo-à-api-da-rede-celcoin.md) - [Credenciais de acesso](https://developers.celcoin.com.br/docs/obtendo-acesso-às-apis.md): Obtenha sua credencial de acesso - [Segurança da API](https://developers.celcoin.com.br/docs/segurança-da-api.md) - [Idempotência das APIs](https://developers.celcoin.com.br/docs/idempotência-das-apis.md): Uso da Idempotência na Celcoin - [Certificado mTLS](https://developers.celcoin.com.br/docs/mtls.md): Para garantir a segurança e a confiabilidade na comunicação com às nossas APIs, é obrigatório o uso de certificados mTLS (Mutual Transport Layer Security) somado ao OAuth 2.0 em todas as requisições. - [Controle de taxa (rate-control)](https://developers.celcoin.com.br/docs/controle-de-taxa-rate-control.md) - [Faça sua primeira consulta](https://developers.celcoin.com.br/docs/tutorial-de-uso-da-api.md) - [Arquivo de movimentação via SFTP](https://developers.celcoin.com.br/docs/arquivo-de-movimentação-via-sftp.md) - [Servidor MCP da Celcoin](https://developers.celcoin.com.br/docs/use-nosso-mcp-server.md) - [Instruções para homologar](https://developers.celcoin.com.br/docs/homologacao-celcoin.md): Neste documento, disponibilizaremos as instruções para a homologação de um produto e o recebimento das credenciais de produção. - [Fluxo de Assinaturas (Docsign)](https://developers.celcoin.com.br/docs/docsign.md): Orientações para clientes que utilizam a nossa solução de fluxo de assinatura. - [Autenticação Biométrica](https://developers.celcoin.com.br/docs/autenticacao-biometrica.md): Orientações para clientes que utilizam a nossa solução de Autenticação de Biometria Facial. - [Sobre o BaaS & Core Banking](https://developers.celcoin.com.br/docs/sobre-o-baas.md) - [Diretriz Termos de Uso - BaaS](https://developers.celcoin.com.br/docs/diretriz-termos-de-uso-baas.md): Diretriz Termos de Uso - BaaS - [Follow the Money (Antifraude e PLD)](https://developers.celcoin.com.br/docs/follow-the-money-ftm.md) - [APP e Internet Banking Whitelabel (MyBenk)](https://developers.celcoin.com.br/docs/soluções-de-front-end-mybenk.md) - [Painel do Cliente (contratante do BaaS ou Core)](https://developers.celcoin.com.br/docs/painel-do-cliente.md) - [Criação de Contas (Onboarding)](https://developers.celcoin.com.br/docs/utilizacao-do-onboarding-celcoin.md): Orientações para clientes que utilizam a nossa solução de Onboarding - KYC. - [Informações financeiras](https://developers.celcoin.com.br/docs/informações-financeiras-1.md): Detalha as informações financeiras necessárias para abertura de contas. - [Webhooks Onboarding](https://developers.celcoin.com.br/docs/webhooks-onboarding.md) - [BC Protege+](https://developers.celcoin.com.br/docs/bc-protege.md) - [Cenários práticos - Abertura de Conta PJ](https://developers.celcoin.com.br/docs/cenários-práticos-abertura-de-conta-pj.md) - [Gestão de Contas](https://developers.celcoin.com.br/docs/gestão-de-contas.md) - [Criar Conta - Apenas Core Banking](https://developers.celcoin.com.br/docs/criar-conta.md) - [Informações financeiras](https://developers.celcoin.com.br/docs/informações-financeiras.md) - [Atualizar Dados do Cliente](https://developers.celcoin.com.br/docs/atualizar-dados-da-conta.md) - [Desativar / Encerrar uma Conta](https://developers.celcoin.com.br/docs/desativar-excluir-a-conta.md) - [Listar Contas](https://developers.celcoin.com.br/docs/listar-contas.md) - [Tabela de erros Gestão de Contas](https://developers.celcoin.com.br/docs/tabela-de-erros-gestão-de-contas.md): As tabelas abaixo apresentam os possíveis erros que podem ser retornados em nossas APIs de baas. - [Número de contas](https://developers.celcoin.com.br/docs/numero-de-contas.md) - [Bloqueios Judiciais](https://developers.celcoin.com.br/docs/bloqueio-judiciais.md) - [Atualização de Status de Conta](https://developers.celcoin.com.br/docs/atualização-de-status-de-conta.md) - [Adicionar Saldo (em sandbox)](https://developers.celcoin.com.br/docs/gerar-lançamento.md) - [Monitoramento cadastral](https://developers.celcoin.com.br/docs/monitoramento-cadastral.md) - [Webhooks - Monitoramento cadastral](https://developers.celcoin.com.br/docs/webhooks-monitoramento-cadastral.md) - [Simulação de Monitoramento Cadastral](https://developers.celcoin.com.br/docs/simulação-de-monitoramento-cadastral.md) - [Relatórios](https://developers.celcoin.com.br/docs/relatórios-2.md) - [Consultar Saldo](https://developers.celcoin.com.br/docs/consultar-saldo-1.md) - [Saldo Dia & Movimentações Diárias Consolidadas](https://developers.celcoin.com.br/docs/consultar-saldo-do-dia.md) - [Consultar Extrato](https://developers.celcoin.com.br/docs/consultar-extrato-1.md) - [Consultar Extrato Detalhado](https://developers.celcoin.com.br/docs/consultar-extrato-copy.md) - [Sobre o Pix](https://developers.celcoin.com.br/docs/sobre-o-pix.md) - [Implantação](https://developers.celcoin.com.br/docs/pix-implantação.md) - [Receber via Pix (Cash-in)](https://developers.celcoin.com.br/docs/pix-cash-in-receber.md) - [Receber um Pix Cash-in por Agência e Conta](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-agencia-e-conta.md) - [Receber um Pix Cash-in por Chave Aleatória](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-por-chave-aleatoria.md) - [Receber um Pix Cash-in por Chaves Individualizadas](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-por-chaves-individualizadas.md) - [Receber um Pix Cash-in por Cobrança estática](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-por-cobranca-estatica.md) - [Receber um Pix Cash-in por QR Code dinâmico (immediate)](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-por-qr-code-dinamico-immediate.md) - [Receber um Pix Cash-in por QR Code dinâmico(duedate)](https://developers.celcoin.com.br/docs/receber-um-pix-cash-in-por-qr-code-dinamico-duedate.md): Criar uma cobrança Pix única, com data de vencimento e expiração, e opção de aplicar multas, juros, descontos e/ou abatimentos - [Bloqueio Cautelar - Recebimento Pix](https://developers.celcoin.com.br/docs/bloqueio-cautelar-recebimento-pix.md) - [Consulta de recebimentos Pix](https://developers.celcoin.com.br/docs/redirecionamento-consulta-de-recebimentos-pix.md): Para consultar recebimentos Pix utilizaremos no BaaS a mesma documentação e endpoint do Pix avulso: - [Devolver um Pix Cash-in](https://developers.celcoin.com.br/docs/realizar-devolução-de-recebimento-pix.md) - [Modelo Webhook](https://developers.celcoin.com.br/docs/webhook-cash-in.md) - [Split - Recebimento de Pix](https://developers.celcoin.com.br/docs/split-pix.md) - [Split de Pix Cash-in por QR Code dinâmico(duedate)](https://developers.celcoin.com.br/docs/split-de-pix-cash-in-por-qr-code-dinâmicoduedate-1.md) - [Split de Pix Cash-in por QR Code dinâmico (immediate)](https://developers.celcoin.com.br/docs/split-de-pix-cash-in-por-qr-code-dinâmico-immediate-1.md) - [Pagamento via Pix (Cash-out)](https://developers.celcoin.com.br/docs/pix-cash-out-pagamento.md) - [DICT](https://developers.celcoin.com.br/docs/dict-2.md): Abaixo estão as funcionalidades e informações a respeito do Diretório de Identificadores de Contas Transacionais - [Consultar Chaves Pix Externa (DICT)](https://developers.celcoin.com.br/docs/consultar-chaves-pix-externa-dict.md): Consultar uma chave Pix para uma conta - [Realizar um Pix Cash-Out por Agência e Conta](https://developers.celcoin.com.br/docs/realizar-um-pix-cash-out.md) - [Realizar um Pix Cash-Out por Chaves Pix](https://developers.celcoin.com.br/docs/realizar-um-pix-cash-out-por-chaves-pix.md) - [Realizar um Pix Cash-Out por QR Code Estático](https://developers.celcoin.com.br/docs/realizar-um-pix-cash-out-por-qr-code-estático.md) - [Realizar um Pix Cash-Out por QR Code Dinâmico](https://developers.celcoin.com.br/docs/realizar-um-pix-cash-out-por-qr-code-dinâmico.md) - [Consultar transferências, pagamentos e devoluções de Pix-Out](https://developers.celcoin.com.br/docs/verifica-o-status-de-uma-transação-pix.md) - [Tabela de erros Cash-Out](https://developers.celcoin.com.br/docs/tabela-de-erros-cash-out.md) - [Modelo Webhook](https://developers.celcoin.com.br/docs/modelo-webhook-cash-out.md) - [Bloqueio Cautelar - Envio Pix](https://developers.celcoin.com.br/docs/bloqueio-cautelar-envio-pix.md) - [Gerenciamento de Chaves](https://developers.celcoin.com.br/docs/pix-gerenciamento-de-chaves.md) - [Cadastrar uma Chave Pix](https://developers.celcoin.com.br/docs/cadastrar-uma-chave-pix.md): Cadastrar uma chave Pix para uma conta - [Excluir Chaves Pix de uma Conta](https://developers.celcoin.com.br/docs/excluir-chaves-pix-de-uma-conta.md): Excluir uma chave Pix para uma conta - [Consultar Chaves Pix de uma Conta](https://developers.celcoin.com.br/docs/consultar-chaves-pix-de-uma-conta-copy.md): Consultar uma chave Pix para uma conta - [Alteração de nome em uma chave Pix](https://developers.celcoin.com.br/docs/alterar-chaves-pix.md): Alterar os dados de uma chave Pix para uma conta - [Portabilidade e Reivindicação de Chaves](https://developers.celcoin.com.br/docs/portabilidade-reivindicacao-de-chaves-pix.md) - [Primeiros passos para Portabilidade e Reivindicação de Chaves Pix](https://developers.celcoin.com.br/docs/primeiros-passos-para-portabilidade-e-reivindicação-de-chaves-pix.md) - [Solicitar Portabilidade de Chave Pix](https://developers.celcoin.com.br/docs/solicitar-portabilidade-de-chave-pix.md) - [Responder Portabilidade de Chave Pix](https://developers.celcoin.com.br/docs/responder-portabilidade-de-chave-pix.md) - [Consultar pedidos de Portabilidade ou Reivindicação](https://developers.celcoin.com.br/docs/consultar-pedidos-de-portabilidade-ou-reinvindicacao.md) - [Tabela de erros portabilidade PIX](https://developers.celcoin.com.br/docs/tabela-de-erros-portabilidade-pix.md) - [Agendador de Transação Pix](https://developers.celcoin.com.br/docs/agendador-de-transacoes.md) - [Agendar uma transação Pix](https://developers.celcoin.com.br/docs/agendar-uma-transação-pix.md) - [Consultar Pix agendado](https://developers.celcoin.com.br/docs/consultar-pix-agendado.md) - [Cancelar um Pix agendado](https://developers.celcoin.com.br/docs/cancelar-pix-agendado.md) - [Consultar Lista de Transações agendadas](https://developers.celcoin.com.br/docs/consultar-transacoes-agendadas.md) - [MED 2.0](https://developers.celcoin.com.br/docs/med-20-baas.md): Recuperação de valores - [Abertura de MED pelo cliente Celcoin](https://developers.celcoin.com.br/docs/abertura-med.md) - [Criar recuperação de valores](https://developers.celcoin.com.br/docs/criar-recuperação-de-valores-1.md) - [Consultar recuperação de valores](https://developers.celcoin.com.br/docs/consultar-recuperação-de-valores.md) - [Cancelar recuperação de valores](https://developers.celcoin.com.br/docs/cancelar-recuperação-de-valores.md) - [Recebimento de valores](https://developers.celcoin.com.br/docs/recebimento-de-valores.md) - [Recebimento de MED pelo cliente Celcoin](https://developers.celcoin.com.br/docs/recebimento-med.md) - [Receber uma recuperação de valores](https://developers.celcoin.com.br/docs/receber-uma-recuperação-de-valores.md) - [Bloqueio de valores](https://developers.celcoin.com.br/docs/bloqueio-de-valores.md) - [Desbloqueio de valores](https://developers.celcoin.com.br/docs/copy-of-bloqueio-e-desbloqueio-de-valores.md) - [Devolução de valores](https://developers.celcoin.com.br/docs/devolução-de-valores.md) - [Webhooks Med 2.0](https://developers.celcoin.com.br/docs/webhooks-med-20.md) - [Pix Automático](https://developers.celcoin.com.br/docs/pix-automático-baas.md) - [Jornada Pagadora](https://developers.celcoin.com.br/docs/jornada-pagadora-baas.md) - [Autorização - Visão Geral](https://developers.celcoin.com.br/docs/autorização-pagador-baas.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/autorização-jornada-1-baas.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/autorização-jornada-2-baas.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/autorização-jornada-3-baas.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/autorização-jornada-4-baas.md) - [Agendamento](https://developers.celcoin.com.br/docs/agendamento-pagador-baas.md) - [Liquidação](https://developers.celcoin.com.br/docs/liquidação-pagador-baas.md) - [Cancelamento do Consentimento](https://developers.celcoin.com.br/docs/cancelamento-pagador-baas.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/docs/cancelamento-do-consentimento-copy.md) - [Consultas - Visão Pagador](https://developers.celcoin.com.br/docs/consultas-visão-pagador.md) - [Jornada Recebedora](https://developers.celcoin.com.br/docs/jornada-recebedora.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/recebedora-jornada-1.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/recebedora-jornada-2-baas.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/recebedora-jornada-2-copy.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/recebedora-jornada-3-copy.md) - [Envio de Agendamento](https://developers.celcoin.com.br/docs/recebedora-envio-de-agendamento.md) - [Liquidação](https://developers.celcoin.com.br/docs/recebedora-envio-de-agendamento-copy.md) - [Retentativas de Recebimento](https://developers.celcoin.com.br/docs/recebedora-retentativas-de-recebimento.md) - [Cancelamento de Agendamento](https://developers.celcoin.com.br/docs/recebedora-cancelamento-de-agendamento-baas.md) - [Cancelamento de Recorrência](https://developers.celcoin.com.br/docs/recebedora-cancelamento-de-pix-automático.md) - [Motivos de rejeição pelo participante pagador](https://developers.celcoin.com.br/docs/motivos-de-rejeição-pelo-participante-pagador.md) - [FAQ](https://developers.celcoin.com.br/docs/faq-2.md): Dúvidas frequentes sobre pix automático - [Sobre o Pix - Participante Indireto](https://developers.celcoin.com.br/docs/sobre-o-pix-indireto-baas.md) - [Pré-requisitos do Participante](https://developers.celcoin.com.br/docs/pré-requisitos-do-participante-baas.md) - [Fases do processo de adesão do Participante Indireto](https://developers.celcoin.com.br/docs/fases-do-processo-de-adesão-do-participante-indireto-baas.md) - [Gestão de Chaves Pix](https://developers.celcoin.com.br/docs/gestão-de-chaves-pix-baas.md) - [Portabilidade e Reivindicação](https://developers.celcoin.com.br/docs/portabilidade-e-reivindicação-baas.md) - [Infrações](https://developers.celcoin.com.br/docs/infrações-baas.md) - [Mecanismo Especial de Devoluções (MED)](https://developers.celcoin.com.br/docs/mecanismo-especial-de-devoluções-med-baas.md) - [Emissão de Boletos](https://developers.celcoin.com.br/docs/cobrancas-avulsas.md) - [Emitir Boleto/Cobrança](https://developers.celcoin.com.br/docs/criar-uma-cobrança-avulsa.md) - [Emitir Boleto/Cobrança com Split de Pagamento](https://developers.celcoin.com.br/docs/criar-uma-cobrança-avulsa-com-split.md) - [Atualizar Boleto](https://developers.celcoin.com.br/docs/atualizar-boleto.md) - [Criar um PDF para uma Cobrança](https://developers.celcoin.com.br/docs/criar-um-pdf-para-uma-cobrança.md) - [Consultar Boleto Emitido](https://developers.celcoin.com.br/docs/consultar-cobranca-avulsa.md) - [Consultar Boletos por Período](https://developers.celcoin.com.br/docs/consultar-cobrança-periodo.md) - [Cancelar Boleto Emitido](https://developers.celcoin.com.br/docs/cancelar-uma-cobrança-avulsa.md) - [Pagamento de boletos](https://developers.celcoin.com.br/docs/pagamento-de-boletos-tributos.md) - [Realizar um pagamento de boletos](https://developers.celcoin.com.br/docs/realizar-um-pagamento-de-boletos.md) - [Consultar Status de uma pagamento de Boleto](https://developers.celcoin.com.br/docs/consultar-status-de-pagamento-de-boleto.md) - [Tabela de erros pagamento de contas](https://developers.celcoin.com.br/docs/tabela-de-erros-pagamento-de-contas.md) - [Transferência entre contas](https://developers.celcoin.com.br/docs/transferencia-entre-contas.md) - [Realizar uma transferência entre contas](https://developers.celcoin.com.br/docs/realizar-uma-transferência-entre-contas.md) - [Consulta status da uma transferência entre contas](https://developers.celcoin.com.br/docs/consultar-status-de-um-transferência-entre-contas-baas.md) - [Tabela de erros transferência entre conta baas](https://developers.celcoin.com.br/docs/tabela-de-erros-transferência-entre-conta-baas.md) - [Recebimento de liquidações do arranjo de cartões via SLC (Domicílio Bancário)](https://developers.celcoin.com.br/docs/recebimento-de-cartoes-slc.md) - [TED](https://developers.celcoin.com.br/docs/transferencia-ted.md): O módulo de TED do BaaS foi desenvolvido para atender a necessidade de transferências interbancárias rápidas e seguras. As transferências TED são amplamente utilizadas no sistema financeiro brasileiro e garantem a transferência de valores entre diferentes instituições no mesmo dia, desde que realizadas dentro do horário comercial estipulado. - [Recebendo Transferências TED na sua Conta BaaS](https://developers.celcoin.com.br/docs/receber-uma-transferência-ted.md) - [Realizar uma Transferência via TED](https://developers.celcoin.com.br/docs/realizar-uma-transferência-via-ted.md) - [Consultar status de um transferência TED](https://developers.celcoin.com.br/docs/consultar-status-de-um-transferência-ted.md) - [Modelos Webhooks](https://developers.celcoin.com.br/docs/webhooks-2.md) - [Débito Veicular](https://developers.celcoin.com.br/docs/debito-veicular-baas.md) - [Consultar Débitos Veiculares](https://developers.celcoin.com.br/docs/consultar-débitos-veiculares.md) - [Efetivar Pagamento de Débitos Veiculares](https://developers.celcoin.com.br/docs/efetivar-pagamento-de-débitos-veiculares.md) - [Débitos Dependentes, Distintos e Obrigatórios](https://developers.celcoin.com.br/docs/débitos-dependentes-distintos-e-obrigatórios-baas.md) - [Recargas](https://developers.celcoin.com.br/docs/recarga.md) - [Consulta de operadoras e valores](https://developers.celcoin.com.br/docs/consulta-de-operadoras-e-valores.md) - [Realizar uma recarga](https://developers.celcoin.com.br/docs/realizar-uma-recarga.md) - [CNAB](https://developers.celcoin.com.br/docs/modulo-cnab-baas.md) - [Processar, Consultar e Baixar CNAB](https://developers.celcoin.com.br/docs/processar-um-arquivo-cnab.md) - [Marcas no Open Finance](https://developers.celcoin.com.br/docs/marcas-no-open-finance.md) - [Listar marcas no Diretório de Participantes do Open Finance](https://developers.celcoin.com.br/docs/listar-marcas-no-open-finance.md) - [Obter detalhes de marcas no Open Finance](https://developers.celcoin.com.br/docs/obter-detalhes-de-marcas-no-open-finance.md) - [Uso e disponibilização de logotipos](https://developers.celcoin.com.br/docs/copy-of-instituições-no-open-finance.md) - [Termos e Condições de uso](https://developers.celcoin.com.br/docs/copy-of-uso-e-disponibilização-de-logotipos.md) - [Recepção de Dados](https://developers.celcoin.com.br/docs/baas-fluxo-de-utilização-da-api-de-dados.md) - [Como funciona consentimento e consumo de dados](https://developers.celcoin.com.br/docs/como-funciona-consentimento-e-consumo-de-dados.md): Aqui voccê encontra os módulos de consentimento - [Limites de Consumo Operacionais dos dados do Open Finance Brasil](https://developers.celcoin.com.br/docs/limites-de-consumo-operacionais-dos-dados-do-open-finance-brasil.md) - [API Resources - Recursos Consentidos](https://developers.celcoin.com.br/docs/api-resources-recursos-consentidos.md) - [API de Dados Cadastrais](https://developers.celcoin.com.br/docs/registration-details.md): Comportamento da API de Dados Cadastrais com relação a Recursos - [API Cartões de Crédito](https://developers.celcoin.com.br/docs/credit-cards.md) - [API Contas](https://developers.celcoin.com.br/docs/accounts.md) - [API Operações de Crédito - Empréstimos](https://developers.celcoin.com.br/docs/credit-operations-loans.md): Endpoints - [API Operações de Crédito - Financiamento](https://developers.celcoin.com.br/docs/credit-operations-financings.md): Endpoints - [API Operações de Crédito - Adiantamento a Depositantes](https://developers.celcoin.com.br/docs/credit-operations-unarranged-accounts-overdraft.md): Endpoints - [API Operações de Crédito - Direitos Creditórios Descontados](https://developers.celcoin.com.br/docs/invoice-financings.md): Endpoints - [API Investimentos - Renda Fixa Bancária](https://developers.celcoin.com.br/docs/investments-bank-fixed-incomes.md) - [API Investimentos - Renda Fixa Crédito](https://developers.celcoin.com.br/docs/investments-credit-fixed-incomes.md) - [API Investimentos - Renda Variável](https://developers.celcoin.com.br/docs/investments-variable-incomes.md) - [API Investimentos - Títulos do Tesouro Direto](https://developers.celcoin.com.br/docs/investments-treasure-titles.md) - [API Investimentos - Fundos de Investimentos](https://developers.celcoin.com.br/docs/investments-funds.md) - [Códigos de Resposta e Cenários de Erro](https://developers.celcoin.com.br/docs/consumo-de-dados-open-finance.md): Cenários de erro - [Jornada Sem Redirecionamento](https://developers.celcoin.com.br/docs/baas-jornada-sem-redirecionamento.md): Este subcapítulo reúne os requisitos e recomendações aplicáveis às jornadas de Pagamentos Sem Redirecionamento (JSR) via Open Finance para jornadas de pagamento. - [Como funciona o Vínculo de Dispositivo da Jornada Sem Redirecionamento](https://developers.celcoin.com.br/docs/baas-criar-vínculo.md) - [Pagamento](https://developers.celcoin.com.br/docs/baas-pagamento.md): Aqui você encontra as telas e jornada de pagamento JSR. - [Documentação Técnica - API](https://developers.celcoin.com.br/docs/baas-documentação-técnica-api.md) - [Criar Vínculo](https://developers.celcoin.com.br/docs/baas-criar-vínculo-1.md) - [Callback do Vínculo](https://developers.celcoin.com.br/docs/baas-callback-do-vínculo.md) - [FIDO Registration Options](https://developers.celcoin.com.br/docs/baas-fido-registration-options.md) - [FIDO Registration](https://developers.celcoin.com.br/docs/baas-fido-registration.md) - [Criar Iniciação de Pagamento - v4](https://developers.celcoin.com.br/docs/baas-criar-iniciação-de-pagamento-v4.md) - [FIDO Sign Options](https://developers.celcoin.com.br/docs/baas-fido-sign-options.md) - [Autorização FIDO](https://developers.celcoin.com.br/docs/baas-autorização-fido.md) - [PIX - v4](https://developers.celcoin.com.br/docs/baas-pix-v4.md) - [Validação da Biometria (FIDO) para o Fluxo da Jornada Sem Redirecionamento](https://developers.celcoin.com.br/docs/validação-da-biometria-fido-para-o-fluxo-da-jornada-sem-redirecionamento.md) - [Transferências Inteligentes - Sweeping Accounts](https://developers.celcoin.com.br/docs/transferências-inteligentes-sweeping-accounts.md) - [Sweeping Accounts - Criação de Payment Initiation](https://developers.celcoin.com.br/docs/sweeping-accounts-criação-de-payment-initiation.md) - [Sweeping Accounts - Execução de Pagamento Pix](https://developers.celcoin.com.br/docs/sweeping-accounts-execução-de-pagamento-pix.md) - [Sweeping Accounts - Consultas](https://developers.celcoin.com.br/docs/sweeping-accounts-consultas.md) - [Sweeping Accounts - Cancelamento de Consentimento](https://developers.celcoin.com.br/docs/sweeping-accounts-cancelamento-de-consentimento-1.md) - [Sweeping Accounts - Webhooks](https://developers.celcoin.com.br/docs/sweeping-accounts-webhooks.md) - [Sweeping Accounts - Máquina de Estados](https://developers.celcoin.com.br/docs/sweeping-accounts-máquina-de-estados.md) - [Pagamento Instantâneo - ITP (Jornada com Redirecionamento)](https://developers.celcoin.com.br/docs/pagamento-instantâneo-itp-jornada-com-redirecionamento.md) - [ITP - Criar Consentimento (Payment Initiation)](https://developers.celcoin.com.br/docs/itp-criar-consentimento-payment-initiation.md) - [ITP - Máquina de Estados - Pagamento ITP](https://developers.celcoin.com.br/docs/itp-máquina-de-estados-pix-itp.md) - [ITP - Callback do Consentimento](https://developers.celcoin.com.br/docs/itp-callback-do-consentimento.md) - [ITP - Consultas](https://developers.celcoin.com.br/docs/itp-consultas.md) - [ITP - Webhooks](https://developers.celcoin.com.br/docs/itp-webhooks.md) - [ITP - Códigos de Resposta HTTP](https://developers.celcoin.com.br/docs/itp-códigos-de-resposta-http.md) - [ITP - Possíveis Erros de Pagamento](https://developers.celcoin.com.br/docs/itp-possíveis-erros-de-pagamento.md) - [Pagamentos Automáticos](https://developers.celcoin.com.br/docs/pix-automático.md) - [Criar Consentimento Recorrente](https://developers.celcoin.com.br/docs/criar-consentimento-recorrente.md) - [Jornada de Autorização](https://developers.celcoin.com.br/docs/jornada-de-autorização.md) - [Callback e Execução de Pagamento Automático](https://developers.celcoin.com.br/docs/callback-e-execução-de-pagamento-automatico.md) - [Retentativas Intradia e Extradia](https://developers.celcoin.com.br/docs/retentativas-intradia-e-extradia.md) - [Consulta e Cancelamento](https://developers.celcoin.com.br/docs/consulta-e-cancelamento.md) - [Webhooks - Pagamento Automático](https://developers.celcoin.com.br/docs/webhooks-pagamento-automático.md) - [Máquina de Estados - Pagamento Automático](https://developers.celcoin.com.br/docs/máquina-de-estados-pagamento-automático.md) - [Detentora de Contas - Ambiente Sandbox](https://developers.celcoin.com.br/docs/detentora-de-contas-ambiente-sandbox.md) - [Massa de Testes para Jornadas de Pagamento](https://developers.celcoin.com.br/docs/massa-de-testes.md): Cenários com parâmetros diferentes para ITP (enrollment e PIX) - [Validar SUCESSO no valor máximo dentro do permitido no vínculo do pix](https://developers.celcoin.com.br/docs/jsr-lim-001.md): [JSR-LIM-001] - 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](https://developers.celcoin.com.br/docs/jsr-lim-001-1.md): [JSR-LIM-001.1] - Validar SUCESSO no valor máximo permitido - [Validar FALHA no valor que excede o limite](https://developers.celcoin.com.br/docs/jsr-lim-002.md): **[JSR-LIM-002] - Fluxo e Condições para Erro de Limite Excedido** - [Validar FALHA por saldo insuficiente](https://developers.celcoin.com.br/docs/jsr-sal-003.md): [JSR-SAL-003] - Validar FALHA por saldo insuficiente - [Validar qual erro prevalece quando ambas as condições, valor limite excedido e saldo insuficiente, falham](https://developers.celcoin.com.br/docs/jsr-mix-004.md): [JSR-MIX-004] - 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](https://developers.celcoin.com.br/docs/jsr-limd-005.md): [JSR-LIMD-005] - Validar FALHA por exceder o limite diário configurado pelo cliente - [Validar FALHA por exceder o limite noturno](https://developers.celcoin.com.br/docs/jsr-limn-006.md): **[JSR-LIMN-006] - Fluxo e Condições para Erro de Limite Noturno Excedido** - [Validar FALHA quando o consentimento (autorização do cliente) está EXPIRADO](https://developers.celcoin.com.br/docs/jsr-cons-007.md): [JSR-CONS-007] - Validar FALHA quando o consentimento (autorização do cliente) está EXPIRADO - [Validar FALHA quando o consentimento é REVOGADO pelo cliente na Instituição Detentora](https://developers.celcoin.com.br/docs/jsr-cons-008.md): [JSR-CONS-008] - Fluxo e Condições para Erro após Cancelamento - [Validar FALHA se o vínculo for REJEITADO por tempo limite de espera](https://developers.celcoin.com.br/docs/jsr-fido-011.md): [JSR-FIDO-011] - Validar FALHA se o vínculo for REJEITADO por tempo limite de espera (Ex: 5 minutos para sinais de risco) - [Subadquirência e AaaS (Acquiring as a Service)](https://developers.celcoin.com.br/docs/subadquirencia.md) - [Credenciamento na Subadquirência](https://developers.celcoin.com.br/docs/credenciamento-sub-adquirência.md) - [Consultar Status do Credenciamento da Conta](https://developers.celcoin.com.br/docs/listar-conta.md) - [Clientes](https://developers.celcoin.com.br/docs/clientes.md) - [Criar Cliente](https://developers.celcoin.com.br/docs/criar-cliente.md) - [Listar Clientes](https://developers.celcoin.com.br/docs/listar-clientes.md) - [Editar Cliente](https://developers.celcoin.com.br/docs/editar-cliente.md) - [Excluir Cliente](https://developers.celcoin.com.br/docs/excluir-cliente.md) - [Cartões](https://developers.celcoin.com.br/docs/cartões.md) - [Criar Cartão](https://developers.celcoin.com.br/docs/criar-cartão.md) - [Listar Cartões](https://developers.celcoin.com.br/docs/listar-cartões.md) - [Inativar Cartão](https://developers.celcoin.com.br/docs/inativar-cartão.md) - [Cobrança Avulsa no Cartão de Crédito](https://developers.celcoin.com.br/docs/cobrança-avulsa-cartão-de-crédito.md) - [Criar Cobrança Avulsa](https://developers.celcoin.com.br/docs/criar-cobrança-avulsa.md) - [Listar Cobranças Avulsas](https://developers.celcoin.com.br/docs/listar-cobrança-avulsa.md) - [Editar Cobrança Avulsa](https://developers.celcoin.com.br/docs/editar-cobrança-avulsa.md) - [Retentar Cobrança Avulsa](https://developers.celcoin.com.br/docs/retentar-cobrança-avulsa.md) - [Estornar Cobrança Avulsa](https://developers.celcoin.com.br/docs/estornar-cobrança-avulsa.md) - [Cancelar Cobrança Avulsa](https://developers.celcoin.com.br/docs/cancelar-cobrança-avulsa.md) - [Capturar Cobrança no Cartão](https://developers.celcoin.com.br/docs/capturar-cobrança-no-cartão-1.md) - [Gestão de Recebíveis](https://developers.celcoin.com.br/docs/gestão-de-recebíveis-1.md) - [Solicitar Relatório de Recebíveis](https://developers.celcoin.com.br/docs/solicitar-relatório-de-recebíveis.md) - [Fazer o Download do Relatório de Recebíveis](https://developers.celcoin.com.br/docs/visualizar-relatório-de-recebíveis.md) - [Listar Solicitações de Relatórios de Recebíveis](https://developers.celcoin.com.br/docs/listar-solicitações-de-relatórios-de-recebíveis.md) - [Antecipação Pontual de Recebíveis](https://developers.celcoin.com.br/docs/antecipação-de-recebíveis.md) - [Consulta de Valores e Recebíveis Elegíveis à Antecipação Pontual](https://developers.celcoin.com.br/docs/cxcx.md) - [Simular Antecipação de Recebíveis](https://developers.celcoin.com.br/docs/simular-antecipação-de-recebíveis.md) - [Efetiva a Antecipação dos Recebíveis](https://developers.celcoin.com.br/docs/efetiva-a-antecipação-dos-recebíveis.md) - [Lista Simulações de Antecipação Realizadas](https://developers.celcoin.com.br/docs/lista-simulações-de-antecipação-realizadas.md) - [Consulta Histórico de Antecipação](https://developers.celcoin.com.br/docs/consulta-histórico-de-antecipação.md) - [Planos](https://developers.celcoin.com.br/docs/planos.md) - [Criar Plano](https://developers.celcoin.com.br/docs/criar-plano.md) - [Listar Planos](https://developers.celcoin.com.br/docs/listar-planos.md) - [Editar Plano](https://developers.celcoin.com.br/docs/editar-plano.md) - [Excluir Plano](https://developers.celcoin.com.br/docs/excluir-plano.md) - [Assinaturas e Contratos](https://developers.celcoin.com.br/docs/assinaturas-e-contratos.md) - [Criar Assinatura com ou sem plano](https://developers.celcoin.com.br/docs/criar-assinaturacontrato-com-plano.md) - [Criar Assinatura/Contrato Manual](https://developers.celcoin.com.br/docs/criar-assinaturacontrato-manual.md) - [Listar Assinaturas/contratos](https://developers.celcoin.com.br/docs/listar-assinaturascontratos.md) - [Adicionar Transação](https://developers.celcoin.com.br/docs/adicionar-uma-transação.md) - [Editar Informações da Assinatura/Contrato](https://developers.celcoin.com.br/docs/editar-informações-da-assinaturacontrato.md) - [Editar Pagamento da Assinatura/Contrato](https://developers.celcoin.com.br/docs/editar-pagamento-da-assinaturacontrato.md) - [Editar Transação](https://developers.celcoin.com.br/docs/editar-transação.md) - [Retentar Cobrança no Cartão](https://developers.celcoin.com.br/docs/retentar-cobrança-no-cartão.md) - [Capturar cobrança no cartão](https://developers.celcoin.com.br/docs/capturar-cobrança-no-cartão.md) - [Estornar Cobrança no Cartão](https://developers.celcoin.com.br/docs/estornar-cobrança-no-cartão.md) - [Cancelar Assinatura/Contrato](https://developers.celcoin.com.br/docs/cancelar-assinaturacontrato.md) - [Cancelar uma Transação](https://developers.celcoin.com.br/docs/cancelar-transação.md) - [Disputas e Chargebacks](https://developers.celcoin.com.br/docs/gestão-de-chargebacks.md) - [Listar Chargebacks](https://developers.celcoin.com.br/docs/listar-chargebacks.md) - [Enviar Documentação de Defesa do Chargeback](https://developers.celcoin.com.br/docs/enviar-documentação-de-defesa-do-chargeback.md) - [Desistir da Disputa dos Chargeback](https://developers.celcoin.com.br/docs/desistir-da-disputa-dos-chargeback.md) - [Cadastrar Webhooks de Chargeback](https://developers.celcoin.com.br/docs/cadastro-de-webhooks-de-chargeback.md) - [Simular Fluxo Chargeback Sandbox](https://developers.celcoin.com.br/docs/simular-chargeback.md) - [Webhooks](https://developers.celcoin.com.br/docs/configurar-webhooks.md) - [Tokenização de Cartão via JS](https://developers.celcoin.com.br/docs/tokenização-de-cartão-via-js.md) - [Listar Taxas](https://developers.celcoin.com.br/docs/listar-taxas.md) - [Listar Transações](https://developers.celcoin.com.br/docs/listar-transações.md) - [Extrato de Recebíveis](https://developers.celcoin.com.br/docs/extrato-de.md) - [Autenticação 3DS](https://developers.celcoin.com.br/docs/3ds.md) - [Informe de Rendimentos](https://developers.celcoin.com.br/docs/informe-de-rendimentos.md) - [Informe de Rendimentos PF](https://developers.celcoin.com.br/docs/informe-de-rendimentos-pf.md) - [Informe de Rendimentos PJ](https://developers.celcoin.com.br/docs/informe-de-rendimentos-pj.md) - [Webhooks](https://developers.celcoin.com.br/docs/webhooks-baas.md) - [Cadastrar e Gerenciar Webhooks](https://developers.celcoin.com.br/docs/gerenciamento-de-webhook.md) - [Reenvio de Webhook](https://developers.celcoin.com.br/docs/reenvio-de-webhook.md) - [Templates de Webhooks do BaaS](https://developers.celcoin.com.br/docs/templates-de-webhooks-do-baas.md) - [Bloqueio/desbloqueio de saldo por infração](https://developers.celcoin.com.br/docs/bloqueiodesbloqueio-de-saldo-por-infração.md) - [Tabela de erros BaaS](https://developers.celcoin.com.br/docs/tabela-de-erros-mapeados.md) - [Core Banking - Lançamento manual](https://developers.celcoin.com.br/docs/lançamento-manual-core-banking.md) - [Realizar lançamento manual](https://developers.celcoin.com.br/docs/realizar-lançamento-manual.md): Realizar lançamento manual em uma conta - [Consultar tipos de lançamento](https://developers.celcoin.com.br/docs/consultar-tipos-de-lançamento.md): Consultar a lista dos tipos de lançamentos cadastrados - [Core Banking - Bloqueio e Desbloqueio de Saldo](https://developers.celcoin.com.br/docs/bloqueio-e-desbloqueio-de-saldo.md) - [Bloqueio de saldo](https://developers.celcoin.com.br/docs/bloqueio-de-saldo.md): Realizar bloqueio de saldo - [Desbloqueio de saldo](https://developers.celcoin.com.br/docs/desbloqueio-de-saldo.md): Realizar desbloqueio de saldo - [Cenários práticos](https://developers.celcoin.com.br/docs/cenários-práticos.md) - [Sobre cel_card](https://developers.celcoin.com.br/docs/cel_card.md) - [Gestão de Conta Cartão](https://developers.celcoin.com.br/docs/onboarding.md) - [Criar uma Conta Cartão (Onboarding)](https://developers.celcoin.com.br/docs/copy-of-criar-conta-cartão-onboarding.md) - [Consultando dados de uma Conta Cartão](https://developers.celcoin.com.br/docs/copy-of-consultando-dados-de-uma-conta-cartão.md) - [Limites da Conta Cartão](https://developers.celcoin.com.br/docs/limites-da-conta-cartão.md) - [Atualizar Dados Cadastrais da Conta Cartão](https://developers.celcoin.com.br/docs/onboarding-copy.md) - [Atualização de telefone](https://developers.celcoin.com.br/docs/atualização-de-telefone.md) - [Cancelamento de conta e cartão](https://developers.celcoin.com.br/docs/copy-of-bia-consultando-fatura-4.md) - [Endereços](https://developers.celcoin.com.br/docs/endereço.md) - [Gestão de Cartões](https://developers.celcoin.com.br/docs/gestão-de-cartão.md) - [Emissão de Cartões](https://developers.celcoin.com.br/docs/emissão-de-cartões.md) - [Emissão/Geração de Cartão](https://developers.celcoin.com.br/docs/emissão-de-cartão-físico.md) - [Emissão de 2ª via de cartão](https://developers.celcoin.com.br/docs/emissão-de-2a-via-de-cartão.md) - [Rastreio de Cartões](https://developers.celcoin.com.br/docs/rastreio-de-cartões.md) - [Consulta de rastreio](https://developers.celcoin.com.br/docs/consulta-de-rastreio.md) - [Simulação de Rastreio do Cartão](https://developers.celcoin.com.br/docs/simulação-de-rastreio-do-cartão.md): Para receber o webhook de card-in-transit é necessário inserir um registro de rastreio para o cartão físico gerado. - [Ativação de Cartão](https://developers.celcoin.com.br/docs/ativação.md) - [Alteração de status](https://developers.celcoin.com.br/docs/alteração-de-status.md) - [Visualização dos dados do cartão](https://developers.celcoin.com.br/docs/visualização-dos-dados-do-cartão.md) - [Listagem de Cartões](https://developers.celcoin.com.br/docs/listagem-de-cartões.md) - [Gestão de senha](https://developers.celcoin.com.br/docs/gestão-de-senha.md) - [Alteração de Senha do Cartão - Pin Online e Pin Offline](https://developers.celcoin.com.br/docs/copy-of-pin-on-line-e-pin-off-line.md): Nesta página saberemos mais sobre o funcionamento do pin online e pin offline. - [Simulador de Transações](https://developers.celcoin.com.br/docs/simulador-de-transacao.md) - [Webhooks](https://developers.celcoin.com.br/docs/webhooks-cartoes.md) - [Cadastrar e Gerenciar Webhooks](https://developers.celcoin.com.br/docs/cadastrar-e-gerenciar-webhooks.md) - [Template de Webhooks](https://developers.celcoin.com.br/docs/modelo-de-webhooks.md) - [Reenvio de Webhook Pendente](https://developers.celcoin.com.br/docs/reenvio-de-webhook-1.md) - [Autenticação](https://developers.celcoin.com.br/docs/autenticação.md) - [Variáveis Personalizadas](https://developers.celcoin.com.br/docs/cel-credit-variaveis-personalizadas.md) - [Solicitações](https://developers.celcoin.com.br/docs/solicitações.md) - [Campos de Solicitação](https://developers.celcoin.com.br/docs/campos-de-solicitação.md) - [Simulações](https://developers.celcoin.com.br/docs/simulações.md) - [Status de Solicitação](https://developers.celcoin.com.br/docs/status-de-solicitacao.md) - [Tabela de Erros de Geração de Boleto](https://developers.celcoin.com.br/docs/tabela-de-erros-de-geração-de-boleto.md) - [Assinatura](https://developers.celcoin.com.br/docs/assinatura.md) - [Modalidades](https://developers.celcoin.com.br/docs/modalidades.md) - [Assinatura via Cláusula Mandato (Timestamp)](https://developers.celcoin.com.br/docs/assinatura-via-cláusula-mandato-timestamp.md) - [Assinatura via Envio de PDF](https://developers.celcoin.com.br/docs/assinatura-via-envio-de-pdf.md) - [Consulta de Assinaturas da CCB](https://developers.celcoin.com.br/docs/consulta-de-assinaturas-da-ccb.md) - [Webhooks](https://developers.celcoin.com.br/docs/webhooks-1.md): A Plataforma de Crédito utiliza webhooks no processo de originação para informar o originador dos eventos relativos à processos assíncronos da plataforma: - [Consignado Crédito Trabalhador](https://developers.celcoin.com.br/docs/consignado-crédito-trabalhador.md) - [Modalidade sem Leilão](https://developers.celcoin.com.br/docs/modalidade-sem-leilao.md) - [Solicitação & Consentimento do Tomador](https://developers.celcoin.com.br/docs/solicitação-consentimento-do-tomador.md) - [Consulta de Margem & Simulação de Crédito](https://developers.celcoin.com.br/docs/consulta-de-margem-simulacao-de-credito.md) - [Consulta de Saldo FGTS & Multa Rescisória FGTS](https://developers.celcoin.com.br/docs/consulta-de-saldo-fgts-disponível.md) - [Cadastro do Tomador, Emissão & Cancelamento](https://developers.celcoin.com.br/docs/cadastro-do-tomador-emissão-cancelamento-1.md) - [Guia rápido consignado](https://developers.celcoin.com.br/docs/guia-rápido-consignado.md) - [Falhas de Averbação – Integração Dataprev](https://developers.celcoin.com.br/docs/cel-credit-erros-de-averbacao-integracao-dataprev.md) - [Status da Operação](https://developers.celcoin.com.br/docs/status-da-operação.md) - [Consultas, Escriturações e Repasses](https://developers.celcoin.com.br/docs/consultas-escriturações-e-repasses.md) - [Consulta Status da Garantia da Operação](https://developers.celcoin.com.br/docs/consulta-status-da-garantia-da-operacao.md) - [Empréstimo Consignado Servidores do Exército](https://developers.celcoin.com.br/docs/empréstimo-consignado-servidores-do-exército.md) - [Autenticação](https://developers.celcoin.com.br/docs/autenticação-3.md) - [Consulta de margem](https://developers.celcoin.com.br/docs/consulta-de-margem-2.md) - [Simulação da CCB](https://developers.celcoin.com.br/docs/simulação-da-ccb-1.md) - [Criação do tomador](https://developers.celcoin.com.br/docs/criação-do-tomador.md) - [Compra com troco](https://developers.celcoin.com.br/docs/compra-com-troco.md) - [Status da Operação](https://developers.celcoin.com.br/docs/status-da-operação-3.md) - [Conta escrow](https://developers.celcoin.com.br/docs/conta-escrow.md) - [Onboarding conta escrow](https://developers.celcoin.com.br/docs/onboarding-conta-escrow.md) - [Fluxo essencial](https://developers.celcoin.com.br/docs/fluxo-essencial.md) - [Depósitos](https://developers.celcoin.com.br/docs/depósitos.md) - [Destinatários e Cobranças (Charges)](https://developers.celcoin.com.br/docs/destinatários-e-cobranças-charges.md) - [Permissões](https://developers.celcoin.com.br/docs/permissões.md) - [Portabilidade de Crédito](https://developers.celcoin.com.br/docs/portabilidade-de-crédito.md) - [Portabilidade de Crédito do Trabalhador](https://developers.celcoin.com.br/docs/cel-credit-portabilidade-de-credito-do-trabalhador.md) - [Portabilidade no ambiente do originador](https://developers.celcoin.com.br/docs/portabilidade-no-ambiente-do-originador.md) - [Simulação de portabilidade de crédito do trabalhador](https://developers.celcoin.com.br/docs/simulação-de-portabilidade-de-crédito-do-trabalhador-1.md) - [Autorização de consulta & consulta de vículo empregatício](https://developers.celcoin.com.br/docs/autorização-de-consulta-consulta-de-vículo-empregatício.md) - [Cadastro do tomador & emissão da CCB de portabilidade](https://developers.celcoin.com.br/docs/cadastro-do-tomador-emissão-da-ccb-de-portabilidade.md) - [Proposta de portabilidade e resposta a proposta](https://developers.celcoin.com.br/docs/proposta-de-portabilidade-e-retorno-da-proposta.md) - [Averbação por portabilidade & envio de contrato](https://developers.celcoin.com.br/docs/averbação-por-portabilidade.md) - [Conta Celcoin](https://developers.celcoin.com.br/docs/conta-celcoin.md) - [Sobre DDA](https://developers.celcoin.com.br/docs/sobre-dda.md) - [Tabela de erros](https://developers.celcoin.com.br/docs/tabela-de-erros-2.md) - [Sobre a API de Débito Veicular](https://developers.celcoin.com.br/docs/sobre-a-api-de-auto.md) - [Enriquecimento de Placas](https://developers.celcoin.com.br/docs/enriquecimento-de-placas-debito-veicular.md) - [Débitos Dependentes, Distintos e Obrigatórios](https://developers.celcoin.com.br/docs/débitos-dependentes-distintos-e-obrigatórios.md) - [Cadastro de Webhook com Autenticação Via Token - JWT](https://developers.celcoin.com.br/docs/cadastro-de-webhook-com-autenticação-via-token-jwt.md) - [Idempotencia](https://developers.celcoin.com.br/docs/idempotencia.md) - [Tabela de erros](https://developers.celcoin.com.br/docs/tabela-de-erros-3.md): Essas tabelas representam os erros que podem ser retornados de forma síncrona. - [Sobre a API de Emissão de Nota Fiscal de Serviços (NFs-e)](https://developers.celcoin.com.br/docs/sobre-a-api-de-emissão-nfse.md) - [Tabela de Erros](https://developers.celcoin.com.br/docs/tabela-de-erros-nfse.md) - [Emissão de Boletos - Conta Única (Direto)](https://developers.celcoin.com.br/docs/emissao-de-boletos.md) - [Gestão de Beneficiários](https://developers.celcoin.com.br/docs/gestao-beneficiario-direto.md) - [Gestão de Carteiras](https://developers.celcoin.com.br/docs/gestao-de-carteiras-direto.md) - [Gestão de Emissão de Boletos](https://developers.celcoin.com.br/docs/gestao-de-emissao-boletos.md) - [Gestão de Baixa de Boletos](https://developers.celcoin.com.br/docs/gestao-de-baixa-boletos.md) - [Tabelas de Erros - Emissão Celcoin](https://developers.celcoin.com.br/docs/tabela-erros-emissao-de-boletos-celcoin.md) - [Sobre as APIs de Pagamento de Contas](https://developers.celcoin.com.br/docs/pagamento-de-contas-1.md) - [Devolução de pagamento de conta](https://developers.celcoin.com.br/docs/devolução-de-pagamento-de-conta.md) - [Massa de dados para testes](https://developers.celcoin.com.br/docs/massa-de-dados-para-teste.md) - [Tabelas de erros das APIs](https://developers.celcoin.com.br/docs/tabelas-de-erros.md) - [Pix - Avulso](https://developers.celcoin.com.br/docs/pix-avulso.md): Redirecionamento para a seção do Pix Avulso - [Sobre recargas nacionais](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais.md) - [Sobre Saques e depósitos](https://developers.celcoin.com.br/docs/saques-e-depósitos.md) - [Sobre as transferências via TED](https://developers.celcoin.com.br/docs/sobre-as-transferências.md) - [APIs para Conciliação](https://developers.celcoin.com.br/docs/redirecionamento-api-para-conciliacao.md) - [SLC (Celcoin como Banco Liquidante)](https://developers.celcoin.com.br/docs/banco-liquidante.md) - [Sobre o Participante Indireto](https://developers.celcoin.com.br/docs/sobre-o-pix-indireto.md) - [Pré-requisitos do Participante](https://developers.celcoin.com.br/docs/pré-requisitos-do-participante.md) - [Fases do processo de adesão do Participante Indireto](https://developers.celcoin.com.br/docs/fases-do-processo-de-adesão-do-participante-indireto.md) - [Gestão de Chaves Pix](https://developers.celcoin.com.br/docs/gestão-de-chaves-pix.md) - [Listar todas as chaves pix de um cliente](https://developers.celcoin.com.br/docs/listar-chaves-pix-de-um-cliente.md) - [Portabilidade e Reivindicação](https://developers.celcoin.com.br/docs/portabilidade-e-reivindicação-1.md) - [Infrações](https://developers.celcoin.com.br/docs/infrações.md) - [Mecanismo Especial de Devoluções (MED)](https://developers.celcoin.com.br/docs/mecanismo-especial-de-devoluções-med.md) - [Marcação de fraude](https://developers.celcoin.com.br/docs/marcação-de-fraude.md) - [MED 2.0](https://developers.celcoin.com.br/docs/med-20.md): Recuperação de valores - [Criação recuperação de valores](https://developers.celcoin.com.br/docs/criar-recuperação-de-valores.md) - [Consulta recuperação de valores](https://developers.celcoin.com.br/docs/consulta-recuperação-de-valores.md) - [Cancela recuperação de valores](https://developers.celcoin.com.br/docs/cancela-recuperação-de-valores.md) - [Cria solicitação de devolução em recuperação de valores](https://developers.celcoin.com.br/docs/cria-solicitação-de-devolução-em-recuperação-de-valores.md) - [Consulta grafo de recuperação de valores](https://developers.celcoin.com.br/docs/consulta-grafo-de-recuperação-de-valores.md) - [Atualizar a recuperação de valores](https://developers.celcoin.com.br/docs/atualizar-a-recuperação-de-valores.md): Atualiza dados de uma Recuperação de Valores. - [Status da Recuperação de Valores](https://developers.celcoin.com.br/docs/webhook-de-status-da-recuperação-de-valores.md) - [Fechar uma Recuperação de valores](https://developers.celcoin.com.br/docs/fechar-uma-recuperação-de-valores.md) - [Fechar devolução em recuperação de valores](https://developers.celcoin.com.br/docs/fechar-devolução-em-recuperação-de-valores.md) - [Autorização](https://developers.celcoin.com.br/docs/autorização.md) - [Receber com Pix (Pix Cash-in Indireto)](https://developers.celcoin.com.br/docs/acesso-às-apis-de-integração.md) - [Pagamentos (Pix cash-out para Indiretos)](https://developers.celcoin.com.br/docs/transferências-e-pagamentos-com-pix-pix-cash-out-para-indiretos.md) - [Recebimentos (Pix Cashin)](https://developers.celcoin.com.br/docs/recebimentos-pix-cashin.md) - [Devolução de recebimentos Pix](https://developers.celcoin.com.br/docs/devolução-de-recebimentos-pix-copy.md) - [Transações fora do SPI - Reporte Bacen ](https://developers.celcoin.com.br/docs/transações-fora-do-spi-reporte-bacen.md): Regras definidas pela Instrução Normativa BCB n° 653 de 28/8/2025 - [Pix Saque/Troco](https://developers.celcoin.com.br/docs/pix-saquetroco.md) - [Tabela de erros para participantes Indiretos do Pix](https://developers.celcoin.com.br/docs/tabela-de-erros-pix-indireto.md) - [Pix Automático](https://developers.celcoin.com.br/docs/pix-automático-copy-1.md) - [Jornada Pagadora](https://developers.celcoin.com.br/docs/jornada-pagadora-copy.md) - [Autorização - Visão Geral](https://developers.celcoin.com.br/docs/autorização-visão-geral-copy.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/autorização-jornada-1-copy-3.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/autorização-jornada-2-copy-3.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/autorização-jornada-3-copy-3.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/autorização-jornada-4-copy-3.md) - [Agendamento](https://developers.celcoin.com.br/docs/agendamento-copy-1.md) - [Liquidação](https://developers.celcoin.com.br/docs/liquidação-copy-3.md) - [Cancelamento do Consentimento](https://developers.celcoin.com.br/docs/cancelamento-do-consentimento-copy-2.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/docs/cancelamento-de-agendamento-copy-3.md) - [Consultas - Visão Pagador](https://developers.celcoin.com.br/docs/consultas-visão-pagador-copy-1.md) - [Jornada Recebedora](https://developers.celcoin.com.br/docs/jornada-recebedora-copy.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/autorização-jornada-1-copy-2.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/autorização-jornada-2-copy-2.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/autorização-jornada-3-copy-2.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/autorização-jornada-4-copy-2.md) - [Envio de Agendamento](https://developers.celcoin.com.br/docs/envio-de-agendamento-copy-1.md) - [Liquidação](https://developers.celcoin.com.br/docs/liquidação-copy-2.md) - [Retentativas de Recebimento](https://developers.celcoin.com.br/docs/retentativas-de-recebimento-copy-1.md) - [Cancelamento de Agendamento](https://developers.celcoin.com.br/docs/cancelamento-de-agendamento-copy-2.md) - [Cancelamento de Recorrência](https://developers.celcoin.com.br/docs/cancelamento-de-recorrência-copy-1.md) - [Modelos de webhooks do Participante Indireto Pix](https://developers.celcoin.com.br/docs/modelos-de-webhooks-do-pix-indireto.md): Nesta pagina você vai encontrar todos os modelos de webhook para os fluxos de Pix Indireto Avulso. - [Download de Certificados de QR Code Pix](https://developers.celcoin.com.br/docs/baixar-certificado.md) - [Cadastrar e Gerenciar Webhooks](https://developers.celcoin.com.br/docs/celbricks-cadastrar-e-gerenciar-webhooks.md) - [Reenvio de Webhook](https://developers.celcoin.com.br/docs/celbricks-reenvio-de-webhook.md) - [Compartilhamento de Dados](https://developers.celcoin.com.br/docs/compartilhamento-de-dados.md): O Compartilhamento de dados envolve fases, das quais serão descritas aqui - [Etapa 1: Consentimento](https://developers.celcoin.com.br/docs/consentimento.md) - [Etapa 2: Direcionamento](https://developers.celcoin.com.br/docs/etapa-2-direcionamento.md) - [Etapa 3: Autenticação](https://developers.celcoin.com.br/docs/etapa-3-autenticação.md) - [Etapa 4: Confirmação](https://developers.celcoin.com.br/docs/etappa-4-confirmação.md) - [Etapa 5: Redirecionamento](https://developers.celcoin.com.br/docs/etapa-5-redirecionamento.md) - [Documentação Técnica: Transmissora](https://developers.celcoin.com.br/docs/documentação-técnica-receptora.md) - [Jornada Com redirecionamento](https://developers.celcoin.com.br/docs/jornada-com-redirecionamento.md): Jornada de iniciação de pagamento em que o cliente é redirecionado para a Detentora para confirmar a transação. - [Documentação Técnica - API](https://developers.celcoin.com.br/docs/documentação-técnica-api.md) - [Criar Iniciação de Pagamento - v4](https://developers.celcoin.com.br/docs/criar-iniciação-de-pagamento-1.md) - [Criar Iniciação de Pagamento - v5](https://developers.celcoin.com.br/docs/criar-iniciação-de-pagamento-v5.md) - [Callback da Iniciação de Pagamento](https://developers.celcoin.com.br/docs/callback-da-iniciação-de-pagamento.md) - [PIX - v4](https://developers.celcoin.com.br/docs/pagamento-1.md) - [PIX - v5](https://developers.celcoin.com.br/docs/pix-v5.md) - [Criar Jornada de Pagamento - v4](https://developers.celcoin.com.br/docs/criar-jornada-de-pagamento-1.md) - [Criar Jornada de Pagamento - v5](https://developers.celcoin.com.br/docs/criar-jornada-de-pagamento-v5.md) - [Listar Jornadas de Pagamento - v4](https://developers.celcoin.com.br/docs/listar-jornadas-de-pagamento-1.md) - [Listar Jornadas de Pagamento - v5](https://developers.celcoin.com.br/docs/listar-jornadas-de-pagamento-v5.md) - [Buscar Jornada de Pagamento - v4](https://developers.celcoin.com.br/docs/buscar-jornada-de-pagamento-1.md) - [Buscar Jornada de Pagamento - v5](https://developers.celcoin.com.br/docs/buscar-jornada-de-pagamento-v5.md) - [Jornada Sem Redirecionamento](https://developers.celcoin.com.br/docs/jornada-sem-redirecionamento.md): Este subcapítulo reúne os requisitos e recomendações aplicáveis às jornadas de Pagamentos Sem Redirecionamento (JSR) via Open Finance para jornadas de pagamento. - [Criar vínculo](https://developers.celcoin.com.br/docs/criar-vínculo.md) - [Pagamento](https://developers.celcoin.com.br/docs/pagamento.md): Aqui você encontra as telas e jornada de pagamento JSR. - [Documentação Técnica - API](https://developers.celcoin.com.br/docs/documentação-técnica-1.md) - [Criar Vínculo](https://developers.celcoin.com.br/docs/criar-vínculo-1.md) - [Callback do Vínculo](https://developers.celcoin.com.br/docs/callback-do-vínculo.md) - [FIDO Registration Options](https://developers.celcoin.com.br/docs/fido-registration-options.md) - [FIDO Registration](https://developers.celcoin.com.br/docs/fido-registration.md) - [Criar Iniciação de Pagamento - v4](https://developers.celcoin.com.br/docs/criar-iniciação-de-pagamento.md) - [Criar Iniciação de Pagamento - v5](https://developers.celcoin.com.br/docs/jsr-criar-iniciação-de-pagamento-v5.md) - [FIDO Sign Options](https://developers.celcoin.com.br/docs/fido-sign-options.md) - [Autorização FIDO](https://developers.celcoin.com.br/docs/autorização-fido.md) - [PIX - v4](https://developers.celcoin.com.br/docs/pix.md) - [PIX - v5](https://developers.celcoin.com.br/docs/jsr-pix-v5.md) - [Criar Jornada de Vínculo](https://developers.celcoin.com.br/docs/criar-jornada-de-vínculo.md) - [Listar Jornadas de Vínculo](https://developers.celcoin.com.br/docs/listar-jornadas-de-vínculo.md) - [Buscar Jornada de Vínculo](https://developers.celcoin.com.br/docs/buscar-jornada-de-vínculo.md) - [Criar Jornada de Pagamento - v4](https://developers.celcoin.com.br/docs/criar-jornada-de-pagamento.md) - [Criar Jornada de Pagamento - v5](https://developers.celcoin.com.br/docs/jsr-criar-jornada-de-pagamento-v5.md) - [Listar Jornadas de Pagamento - v4](https://developers.celcoin.com.br/docs/listar-jornadas-de-pagamento.md) - [Listar Jornadas de Pagamento - v5](https://developers.celcoin.com.br/docs/jsr-listar-jornadas-de-pagamento-v5.md) - [Buscar Jornada de Pagamento - v4](https://developers.celcoin.com.br/docs/buscar-jornada-de-pagamento.md) - [Buscar Jornada de Pagamento - v5](https://developers.celcoin.com.br/docs/jsr-buscar-jornada-de-pagamento-v5.md) - [Brick Bank](https://developers.celcoin.com.br/docs/sobre-o-bricks.md): Conecte-se ao Open Finance em tempo recorde! - [Brick Insurance](https://developers.celcoin.com.br/docs/brick-bank-copy.md) - [Open Plus](https://developers.celcoin.com.br/docs/open-plus.md) - [Portal](https://developers.celcoin.com.br/docs/portal.md) - [Cadastro e acesso](https://developers.celcoin.com.br/docs/cadastro-e-acesso.md) - [Hall Open Plus](https://developers.celcoin.com.br/docs/hall-open-plus.md) - [Gestão de aplicações](https://developers.celcoin.com.br/docs/gestão-de-aplicações.md) - [Catálogo de produtos](https://developers.celcoin.com.br/docs/catálogo-de-produtos.md) - [Gestão de membros da equipe](https://developers.celcoin.com.br/docs/gestão-de-membros-da-equipe.md) - [Menu de usuário](https://developers.celcoin.com.br/docs/menu-de-usuário.md) - [Painel de gestão da aplicação](https://developers.celcoin.com.br/docs/painel-de-gestão-da-aplicação.md) - [Painel de gestão do produto](https://developers.celcoin.com.br/docs/painel-de-gestão-do-produto.md) - [Documentação de produto](https://developers.celcoin.com.br/docs/documentação-de-produto.md) - [Credenciais e usuário de teste](https://developers.celcoin.com.br/docs/credenciais-e-usuário-de-teste.md) - [Subir em produção](https://developers.celcoin.com.br/docs/subir-em-produção.md) - [Portal Configurações](https://developers.celcoin.com.br/docs/portal-configurações.md) - [Plataforma de Iniciação (ITP)](https://developers.celcoin.com.br/docs/solução-de-pagamentos-itp.md) - [Portal de configurações do Open Keys](https://developers.celcoin.com.br/docs/portal-de-configurações-do-open-keys.md): Através desta opção, tenha acesso aos recursos proprietários da ferramenta - [Dashboard](https://developers.celcoin.com.br/docs/dashboard.md) - [Lista de Transações](https://developers.celcoin.com.br/docs/lista-de-transações.md) - [Lista de Vínculos de Conta](https://developers.celcoin.com.br/docs/lista-de-vínculos-conta.md) - [Relatórios](https://developers.celcoin.com.br/docs/relatórios-4.md) - [Configurações da jornada de pagamentos](https://developers.celcoin.com.br/docs/configurações-da-jornada-de-pagamentos.md) - [Demo das Jornadas de Pagamento](https://developers.celcoin.com.br/docs/demo-das-jornadas-de-pagamento.md): Ambiente de demonstração das jornadas de pagamento. - [Demo da Área de Gestão](https://developers.celcoin.com.br/docs/demo-da-área-de-gestão.md): Ambiente de demonstração da área de gestão de pagamentos e contas. - [Jornadas White Label](https://developers.celcoin.com.br/docs/jornadas-white-label.md) - [Iniciação de Pagamento Instantâneo](https://developers.celcoin.com.br/docs/iniciação-de-pagamento-instantâneo.md) - [Gestão de Pagamentos Instantâneos](https://developers.celcoin.com.br/docs/gestão-de-pagamentos-instantâneos.md) - [Iniciação de Pagamento Agendado](https://developers.celcoin.com.br/docs/iniciação-de-pagamento-agendado.md) - [Gestão de Pagamentos Agendados](https://developers.celcoin.com.br/docs/gestão-de-pagamentos-agendados.md) - [Iniciação de Pagamento sem Redirecionamento](https://developers.celcoin.com.br/docs/iniciação-de-pagamento-sem-redirecionamento.md) - [Gestão de Contas Salvas (Vínculos)](https://developers.celcoin.com.br/docs/gestão-de-contas-salvas-vínculos.md) - [Iniciação de Pagamento Automático](https://developers.celcoin.com.br/docs/iniciação-de-pagamento-automático.md) - [Gestão de Pagamentos Automáticos](https://developers.celcoin.com.br/docs/gestão-de-pagamentos-automáticos.md) - [FAQ Open Keys](https://developers.celcoin.com.br/docs/faq-open-keys.md) - [Jornada Pay by Link](https://developers.celcoin.com.br/docs/perguntas-frequentes.md) - [Pagamento por Aproximação](https://developers.celcoin.com.br/docs/pagamento-por-aproximacao.md): Fluxo de Pagamento de Jornada Sem Redirecionamento via NFC - [Documentação técnica](https://developers.celcoin.com.br/docs/documentação-técnica.md) - [Status e respostas: Máquina de estados](https://developers.celcoin.com.br/docs/status-e-respostas-máquina-de-estados.md) - [Status e respostas: Códigos de resposta HTTP](https://developers.celcoin.com.br/docs/status-e-respostas-códigos-de-resposta-http.md) - [Status e respostas: Possíveis erros de pagamentos](https://developers.celcoin.com.br/docs/status-e-respostas-possíveis-erros-de-pagamentos.md) - [Diagrama de sequência: Jornada com Redirecionamento](https://developers.celcoin.com.br/docs/diagrama-de-sequência-jornada-com-redirecionamento.md) - [Diagrama de sequência: Jornada sem Redirecionamento](https://developers.celcoin.com.br/docs/diagrama-de-sequência-jornada-sem-redirecionamento.md) - [Webhook](https://developers.celcoin.com.br/docs/webhook-itp.md) - [APIs](https://developers.celcoin.com.br/docs/apis-itp.md) - [Transferências inteligentes (Sweeping Accounts)](https://developers.celcoin.com.br/docs/sweeping-accounts.md) - [Criar consentimento](https://developers.celcoin.com.br/docs/sweeping-accounts-criar-consentimento.md) - [Callback do Consentimento](https://developers.celcoin.com.br/docs/sweeping-accounts-callback-do-consentimento.md) - [Cancelamento de consentimento](https://developers.celcoin.com.br/docs/sweeping-accounts-cancelamento-de-consentimento.md) - [Listar Consentimentos](https://developers.celcoin.com.br/docs/sweeping-accounts-listar-consentimentos.md) - [Buscar informações de um consentimento](https://developers.celcoin.com.br/docs/sweeping-accounts-buscar-informações-de-um-consentimento.md) - [Criação de uma sessão de jornada](https://developers.celcoin.com.br/docs/sweeping-accounts-criação-de-uma-sessão-de-jornada.md): A API **OK - ITP (Open Keys - Iniciação de Transação de Pagamento)** permite a criação de sessões de jornada para o fluxo de **Sweeping Accounts V2**. Uma sessão de jornada representa o ponto de entrada para iniciar o processo de consentimento de transferências automáticas de fundos, onde o usuário pagador será redirecionado para a detentora de conta para autorizar o consentimento de sweeping accounts. - [Listar sessões de jornada](https://developers.celcoin.com.br/docs/sweeping-accounts-listar-sessões-de-jornada.md) - [Buscar informações de uma sessão de jornada](https://developers.celcoin.com.br/docs/sweeping-accounts-buscar-informações-de-sessao-de-jornada.md) - [Transferências Inteligentes](https://developers.celcoin.com.br/docs/sweeping-accounts-v2.md) - [Migração da API de Pagamentos V4 para V5](https://developers.celcoin.com.br/docs/migração-da-api-de-pagamentos-v4-para-v5.md) - [Sobre o Pix](https://developers.celcoin.com.br/docs/sobre-pix.md) - [Receber com Pix (cash-in)](https://developers.celcoin.com.br/docs/criar-cobrancas-com-pix-cashin.md) - [Cobrança imediata com QR Code dinâmico (immediate)](https://developers.celcoin.com.br/docs/cobranca-imediata-com-qrcode-dinamico.md) - [Cobrança com vencimento com QR Code dinâmico (duedate)](https://developers.celcoin.com.br/docs/qrcode-de-cobranca-com-vencimento.md): Criar uma cobrança Pix única, com data de vencimento e expiração, e opção de aplicar multas, juros, descontos e/ou abatimentos - [Cobrança estática](https://developers.celcoin.com.br/docs/cobranca-com-qrcode-estatico.md) - [Consulta de recebimentos Pix](https://developers.celcoin.com.br/docs/consultar-recebimentos-pix.md) - [Devolução de recebimentos Pix](https://developers.celcoin.com.br/docs/devolução-de-um-recebimento-pix.md) - [Transferências e pagamentos com Pix (cash-out)](https://developers.celcoin.com.br/docs/pagar-e-transferir-com-pix-cashout.md) - [DICT](https://developers.celcoin.com.br/docs/dict-1.md): Neste tópico disponibilizaremos todas as funcionalidades e observações associadas a consulta de chaves Pix no Diretório de Identificadores de Contas Transacionais - [Balde de Fichas](https://developers.celcoin.com.br/docs/balde-de-fichas.md): Conhecer o funcionamento do Balde de Fichas para consultas de chaves no DICT é essencial para evitar interrupção nos serviços. - [Transferência Pix a partir de dados bancários](https://developers.celcoin.com.br/docs/transferencia-pix-com-dados-bancarios.md) - [Transferência Pix a partir de uma chave](https://developers.celcoin.com.br/docs/transferencia-para-uma-chave-pix.md) - [Pagamento de um QR Code Estático](https://developers.celcoin.com.br/docs/pagamento-de-um-qrcode-estatico.md) - [Pagamento de um QR Code Dinâmico](https://developers.celcoin.com.br/docs/pagamento-de-um-qrcode-dinamico.md) - [Pix entre contas (Pix Interno)](https://developers.celcoin.com.br/docs/pagamento-de-um-qr-code-dinâmico-copy.md) - [Consultar transferências, pagamentos e devoluções de Pix-Out](https://developers.celcoin.com.br/docs/consultar-status-de-um-pagamento-pix.md) - [Pagamento de um QR Code (estático ou dinâmico)](https://developers.celcoin.com.br/docs/pagamento-de-um-qr-code-estatico-ou-dinamico.md) - [Pix Automático](https://developers.celcoin.com.br/docs/pix-automático-copy-copy.md) - [Jornada Pagadora](https://developers.celcoin.com.br/docs/jornada-pagadora-copy-copy.md) - [Autorização - Visão Geral](https://developers.celcoin.com.br/docs/autorização-visão-geral-copy-copy.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/autorização-jornada-1-copy-5.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/autorização-jornada-2-copy-5.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/autorização-jornada-3-copy-5.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/autorização-jornada-4-copy-5.md) - [Agendamento](https://developers.celcoin.com.br/docs/agendamento-copy-2.md) - [Liquidação](https://developers.celcoin.com.br/docs/liquidação-copy-5.md) - [Cancelamento do Consentimento](https://developers.celcoin.com.br/docs/cancelamento-do-consentimento-copy-3.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/docs/cancelamento-de-agendamento-copy-5.md) - [Consultas - Visão Pagador](https://developers.celcoin.com.br/docs/consultas-visão-pagador-copy-2.md) - [Jornada Recebedora](https://developers.celcoin.com.br/docs/jornada-recebedora-copy-copy.md) - [Autorização - Jornada 1](https://developers.celcoin.com.br/docs/autorização-jornada-1-copy-4.md) - [Autorização - Jornada 2](https://developers.celcoin.com.br/docs/autorização-jornada-2-copy-4.md) - [Autorização - Jornada 3](https://developers.celcoin.com.br/docs/autorização-jornada-3-copy-4.md) - [Autorização - Jornada 4](https://developers.celcoin.com.br/docs/autorização-jornada-4-copy-4.md) - [Envio de Agendamento](https://developers.celcoin.com.br/docs/envio-de-agendamento-copy-2.md) - [Cancelamento de Agendamento](https://developers.celcoin.com.br/docs/copy-of-cancelamento-de-agendamento.md) - [Cancelamento de Recorrência](https://developers.celcoin.com.br/docs/copy-of-cancelamento-de-recorrência.md) - [Liquidação](https://developers.celcoin.com.br/docs/liquidação-copy-4.md) - [Retentativas de Recebimento](https://developers.celcoin.com.br/docs/retentativas-de-recebimento-copy-2.md) - [Tabela de erros Pix](https://developers.celcoin.com.br/docs/tabela-de-erros-pix.md) - [Modelos Template de webhooks do Pix](https://developers.celcoin.com.br/docs/modelos-de-webhooks-do-pix.md) - [Sobre API de Conciliação](https://developers.celcoin.com.br/docs/sobre-api-de-conciliação.md) - [Sobre API de Extrato Consolidado](https://developers.celcoin.com.br/docs/sobre-api-de-extrato-consolidado.md) - [Tabela de Erros](https://developers.celcoin.com.br/docs/tabela-de-erros-conciliacao.md) - [SLA de atendimento](https://developers.celcoin.com.br/docs/sla-de-atendimento.md): Esse artigo mostra como funciona o SLA de atendimento da Celcoin. - [Listagem de Tickets](https://developers.celcoin.com.br/docs/listagem-de-tickets.md): Essa funcionalidade permitirá à sua empresa mais visibilidade e controle sobre os tickets relacionados à sua operação em nossa central de atendimento. Ao chamar o endpoint descrito neste documento retornaremos uma lista com os últimos 200 tickets de suporte ao cliente abertos em nossa central de atendimento, com opções de filtragem por status e data de atualização. - [Follow the Money](https://developers.celcoin.com.br/docs/follow-the-money.md): Plataforma Anti-Fraude da Celcoin - [Validação AntiFraude Pix](https://developers.celcoin.com.br/docs/validação-antifraude-pix.md) ## API Reference - [Gera o token para autenticação dos endpoints da API.](https://developers.celcoin.com.br/reference/post_v5-token.md) - [Onboarding](https://developers.celcoin.com.br/reference/propostas.md): Endpoints relacionados a gestão de propostas de Onboarding (criação de contas no BaaS). - [Criar proposta Pessoa Física.](https://developers.celcoin.com.br/reference/criar-proposta-pessoa-fisica.md): Endpoint para criar uma nova proposta de Pessoa Física. - [Criar proposta pessoa jurídica](https://developers.celcoin.com.br/reference/criar-uma-proposta-pessoa-jurídica.md) - [Buscar uma proposta ou uma lista de propostas.](https://developers.celcoin.com.br/reference/consultar-proposta.md): Endpoint para consultar uma proposta ou uma lista de propostas. - [Busca um arquivo ou uma lista de arquivos.](https://developers.celcoin.com.br/reference/buscar-arquivos-proposta.md): Endpoint para buscar arquivos vinculados a uma proposta. - [Busca tagueamento da jornada do webview.](https://developers.celcoin.com.br/reference/buscar-tagueamento-jornada-webview.md): Endpoint para buscar o tagueamento da jornada do webview de uma proposta. - [Abertura de conta e KYC](https://developers.celcoin.com.br/reference/api-para-onboarding.md): A criação de contas no BaaS e KYC serão realizados na sessão de Onboarding - [Verificar Status da Conta.](https://developers.celcoin.com.br/reference/verificar-status-da-conta.md) - [Atualizar dados do Cliente PF](https://developers.celcoin.com.br/reference/atualizar-dados-do-cliente.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/atualizar-dados-da-conta - [Atualizar dados do Cliente PJ](https://developers.celcoin.com.br/reference/atualizar-dados-do-cliente-pj.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/atualizar-dados-da-conta - [Retorna informações de conta PF](https://developers.celcoin.com.br/reference/retorna-informações-da-conta.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/listar-contas - [Retorna informações de conta PJ](https://developers.celcoin.com.br/reference/retorna-informações-de-conta-pj.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/listar-contas - [Retorna informações de varias contas PF](https://developers.celcoin.com.br/reference/retorna-informações-de-varias-contas.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/listar-contas - [Retorna informações de varias contas PJ](https://developers.celcoin.com.br/reference/retorna-informações-de-varias-contas-pj.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/listar-contas - [Altera status da conta](https://developers.celcoin.com.br/reference/altera-status-da-conta.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/desativar-excluir-a-conta - [Encerra conta](https://developers.celcoin.com.br/reference/encerra-conta.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/desativar-excluir-a-conta - [Simulação de Monitoramento Cadastral](https://developers.celcoin.com.br/reference/simulação-de-monitoramento-cadastral.md) - [Criar Conta PJ](https://developers.celcoin.com.br/reference/criar-conta-pj.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/criar-conta - [Criar Conta PF](https://developers.celcoin.com.br/reference/criar-conta-pf.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/criar-conta - [Consultar Saldo](https://developers.celcoin.com.br/reference/consultar-saldo.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-saldo-1 - [Consultar Saldo do Dia](https://developers.celcoin.com.br/reference/consultar-saldo-dia.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-saldo-do-dia - [Consultar Extrato](https://developers.celcoin.com.br/reference/consultar-extrato.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-extrato-1 - [Consultar Extrato Detalhado (Beta)](https://developers.celcoin.com.br/reference/consultar-extrato-detalhado.md) - [Realizar uma transferência entre contas](https://developers.celcoin.com.br/reference/realizar-uma-transferência-entre-contas.md) - [Consultar status de uma transferência interna](https://developers.celcoin.com.br/reference/consultar-status-de-uma-transferência-interna.md) - [Consulta EMV QRCode](https://developers.celcoin.com.br/reference/redirect-consulta-emv.md): Para consultar o EMV de um QRCode utilizaremos no BaaS o mesmo endpoint do Pix avulso: - [Consultar uma chave Pix (DICT)](https://developers.celcoin.com.br/reference/consulta-informações-da-chave-pix-externa.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-chaves-pix-externa-dict - [Pix Cashout](https://developers.celcoin.com.br/reference/realizar-transferência-pix.md): Retornará o evento de confirmação via webhook **pix-payment-out** Confira nosso tutorial -> https://developers.celcoin.com.br/docs/pix-cash-out-pagamento - [Verificar Status do PIX](https://developers.celcoin.com.br/reference/verificar-status-do-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/verifica-o-status-de-uma-transa%C3%A7%C3%A3o-pix - [Lista Participantes do PIX](https://developers.celcoin.com.br/reference/participantes-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/sobre-o-pix - [Criação de QRCode](https://developers.celcoin.com.br/reference/baas-criação-de-qrcode.md): Ao receber um Pix será disparado o evento via webhook **pix-payment-in** Para a criação de QRCodes utilizaremos no BaaS os mesmos endpoints do Pix avulso: - [Consulta status de QRCode](https://developers.celcoin.com.br/reference/baas-recebimento-cash-in-consulta-status.md): Ao criar um QRCode é possivel consultar os detalhes e status nos seguintes endpoints: - [Consulta de recebimentos Pix](https://developers.celcoin.com.br/reference/consulta-dados-de-recebimentos.md): Para consultar os dados de um recebimento Pix (MANUAL, DICT ou QRCODE) após o gatilho via webhook, utilizaremos no BaaS o mesmo endpoint do Pix avulso: - [Iniciar a Devolução de um Recebimento Pix](https://developers.celcoin.com.br/reference/iniciar-uma-devolução-pix.md): Retornará o evento de confirmação via webhook **pix-reversal-out** - [Consultar o Status de uma Devolução de Recebimento Pix](https://developers.celcoin.com.br/reference/consultar-status-devolucao-pix.md) - [Consultar uma devolução de Pix-out](https://developers.celcoin.com.br/reference/devolução-de-pagamento-cash-out.md): Relacionado ao evento webhook **pix-reversal-in** - [Criar chaves Pix](https://developers.celcoin.com.br/reference/criar-chaves-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/cadastrar-uma-chave-pix - [Consultar chaves Pix de uma conta](https://developers.celcoin.com.br/reference/consulta-informações-da-chave-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/consultar-chaves-pix-de-uma-conta-copy - [Excluir chaves Pix](https://developers.celcoin.com.br/reference/excluir-chaves-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/excluir-chaves-pix-de-uma-conta - [Alteração de nome em uma chave Pix](https://developers.celcoin.com.br/reference/alterar-chave-pix.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/alterar-chaves-pix - [Cadastra nova reivindicação/portabilidade de chave Pix](https://developers.celcoin.com.br/reference/cadastrar-portabilidade-reivindicacao-de-chaves-pix.md) - [Confirma nova reivindicação/portabilidade de chave Pix](https://developers.celcoin.com.br/reference/confirmar-reivindicação-portabilidade-de-chave-pix.md) - [Cancela nova reivindicação/portabilidade de chave Pix](https://developers.celcoin.com.br/reference/cancela-reivindicacao-e-portabilidade-de-chave-pix.md) - [Consulta reivindicação/portabilidade de chave Pix](https://developers.celcoin.com.br/reference/consulta-reivindicacao-e-portabilidade-de-chave-pix.md) - [Consulta lista de reivindicação/portabilidade de chave Pix](https://developers.celcoin.com.br/reference/consulta-lista-de-reivindicacao-e-portabilidade-de-chave-pix.md) - [Split de Pix Cash-in por QR Code dinâmico(duedate)](https://developers.celcoin.com.br/reference/split-de-pix-cash-in-por-qr-code-dinâmicoduedate-1.md) - [Split de Pix Cash-in por QR Code dinâmico (immediate)](https://developers.celcoin.com.br/reference/split-de-pix-cash-in-por-qr-code-dinâmico-immediate-1.md) - [Aceita uma recorrência Jornada 1](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-jornada-1.md) - [Aceita uma recorrência jornada 2](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-jornada-2.md) - [Aceita uma recorrência Jornada 3](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-jornada-3.md) - [Aceita uma recorrência jornada 4](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-jornada-4.md) - [Recusa uma recorrência](https://developers.celcoin.com.br/reference/recusa-uma-recorrência-baas.md) - [Busca recorrências por status com paginação](https://developers.celcoin.com.br/reference/busca-recorrências-por-status-com-paginação-baas.md) - [Busca uma recorrência pelo ID](https://developers.celcoin.com.br/reference/busca-uma-recorrência-pelo-id-baas.md) - [Cancelamento de Autorização](https://developers.celcoin.com.br/reference/cancelamento-de-autorização-baas.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/reference/cancelamento-de-agendamento-baas.md) - [Crie uma recorrência com jornada 1](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-jornada-1.md) - [Crie uma recorrência com a jornada 2](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-a-jornada-dois-baas.md) - [Crie uma recorrência jornada 3](https://developers.celcoin.com.br/reference/crie-uma-recorrência-jornadas-3-e-4.md): Jornada de autorização com pagamento imediato. - [Crie uma recorrência jornada 4](https://developers.celcoin.com.br/reference/crie-uma-recorrência-jornada-4.md) - [Envio de agendamento](https://developers.celcoin.com.br/reference/envio-de-agendamento.md) - [Retentativas de recebimento](https://developers.celcoin.com.br/reference/retentativas-de-recebimento.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/reference/cancelamento-de-agendamento-2.md) - [Cancelamento da recorrência](https://developers.celcoin.com.br/reference/cancelamento-da-recorrência.md) - [Consulta por recorrência](https://developers.celcoin.com.br/reference/consulta-por-recorrência.md) - [Consulta lista de recorrências](https://developers.celcoin.com.br/reference/consulta-lista-de-recorrências.md) - [Criar consentimento para transação de Sweeping Accounts](https://developers.celcoin.com.br/reference/get_new-endpoint-2.md): Método para criação de consentimento de longa duração. Retorna um recurringConsentId no status AWAITING_AUTHORISATION. - [Cancelar consetimento de longo prazo](https://developers.celcoin.com.br/reference/patch_new-endpoint.md): change sweeping account status - [Detalhar Consentimento](https://developers.celcoin.com.br/reference/get_open-keysitpapiv2sweeping-accountsv2payment-initiation-1.md): Método para buscar dados de um consentimento de transferências inteligentes (sweeping accounts). - [Listar consentimentos](https://developers.celcoin.com.br/reference/post_open-keysitpapiv2payment-initiationcallback-1.md): Método para listagem de consentimentos de transferências inteligentes (sweeping accounts). - [Agendar um Pix Cashout](https://developers.celcoin.com.br/reference/agendar-pix-cashout-baas.md) - [Consultar agendamento de pix](https://developers.celcoin.com.br/reference/consultar-agendamento-de-pix-baas.md) - [Cancelar agendamento de pix](https://developers.celcoin.com.br/reference/cancelar-agendamento-de-pix-baas.md) - [Endpoint responsável por listar agendamentos](https://developers.celcoin.com.br/reference/lista-pix-agendado-baas.md) - [Enviar uma TED](https://developers.celcoin.com.br/reference/enviar-uma-transferencia-ted.md) - [Consultar Status de uma transferência TED](https://developers.celcoin.com.br/reference/consultar-status-de-uma-ted.md) - [Emitir Boleto](https://developers.celcoin.com.br/reference/criar-cobranca-avulsa.md) - [Atualizar Boleto](https://developers.celcoin.com.br/reference/atualizar-boleto.md) - [Consultar Boleto Emitido](https://developers.celcoin.com.br/reference/consultar-staus-cobranca-avulsa.md) - [Consulta de Boletos por Período (BETA)](https://developers.celcoin.com.br/reference/consulta-boleto-periodo.md) - [Cancelar Boleto Emitido](https://developers.celcoin.com.br/reference/delete_charge-transactionid.md) - [Gerar PDF para um Boleto Emitido](https://developers.celcoin.com.br/reference/gerar-um-pdf-para-uma-cobrança.md) - [Processamento de Arquivo CNAB](https://developers.celcoin.com.br/reference/processamento-de-arquivo-cnab.md) - [Consulta de Dados CNAB enviado](https://developers.celcoin.com.br/reference/consulta-de-dados-cnab-enviado.md) - [Baixar arquivo retorno do CNAB pelo id.](https://developers.celcoin.com.br/reference/baixar-arquivo-retorno-do-cnab-pelo-id.md) - [Baixar arquivo remessa do CNAB pelo id.](https://developers.celcoin.com.br/reference/baixar-arquivo-remessa-do-cnab-pelo-id.md) - [Pagamento de conta.](https://developers.celcoin.com.br/reference/efetuar-pagamento-de-conta.md) - [Status de um Pagamento de conta.](https://developers.celcoin.com.br/reference/consultar-status-de-pagamento-de-conta.md) - [Realizar Recarga](https://developers.celcoin.com.br/reference/efetuar-uma-recarga.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/realizar-uma-recarga - [Consultar Recarga](https://developers.celcoin.com.br/reference/consultar-recarga.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/realizar-uma-recarga - [Criar pedido de consulta de débitos veiculares.](https://developers.celcoin.com.br/reference/criar-pedido-de-consulta-de-débitos-veiculares.md) - [Consultar pedido de consulta de débitos veiculares.](https://developers.celcoin.com.br/reference/consultar-pedido-de-consulta-de-débitos-veiculares.md) - [Realizar pagamento de Débito Veicular](https://developers.celcoin.com.br/reference/realizar-pagamento-debito-veicular.md) - [Consultar pagamento e débitos veiculares.](https://developers.celcoin.com.br/reference/consultar-pagamento-de-debitos-veiculares.md) - [Consultar Informe de Rendimentos](https://developers.celcoin.com.br/reference/consultar-informe-de-rendimentos.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/informe-de-rendimentos - [Consultar Status do Credenciamento da Conta](https://developers.celcoin.com.br/reference/get_baas-v1-cash-accreditation.md) - [Credenciar Conta Baas na Sub Celcoin](https://developers.celcoin.com.br/reference/post_baas-v1-cash-accreditation-mainaccount-account.md) - [Listar clientes](https://developers.celcoin.com.br/reference/get_baas-v1-cash-customers.md) - [Criar cliente](https://developers.celcoin.com.br/reference/post_baas-v1-cash-customers.md) - [Editar cliente](https://developers.celcoin.com.br/reference/put_baas-v1-cash-customers-customerid-typeid.md) - [Excluir cliente](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-customers-customerid-typeid.md) - [Listar cartão](https://developers.celcoin.com.br/reference/get_baas-v1-cash-cards.md) - [Criar cartão](https://developers.celcoin.com.br/reference/post_baas-v1-cash-cards-customerid-typeid.md) - [Inativar Cartão](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-cards-customerid-typeid.md) - [Listar cobranças](https://developers.celcoin.com.br/reference/get_baas-v1-cash-charges.md) - [Criar cobrança](https://developers.celcoin.com.br/reference/post_baas-v1-cash-charges.md) - [Editar cobrança](https://developers.celcoin.com.br/reference/put_baas-v1-cash-charges-chargeid-typeid.md) - [Cancelar cobrança](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-charges-chargeid-typeid.md) - [Retentar cobrança](https://developers.celcoin.com.br/reference/put_baas-v1-cash-charges-chargeid-typeid-retry.md) - [Estornar cobrança](https://developers.celcoin.com.br/reference/put_baas-v1-cash-charges-chargeid-typeid-reverse.md) - [Capturar Cobrança no Cartão](https://developers.celcoin.com.br/reference/put_baas-v1-cash-charges-chargeid-typeid-capture.md) - [Criar plano](https://developers.celcoin.com.br/reference/post_baas-v1-cash-plans.md) - [Listar planos](https://developers.celcoin.com.br/reference/get_baas-v1-cash-plans.md) - [Editar plano](https://developers.celcoin.com.br/reference/put_baas-v1-cash-plans-planid-typeid.md) - [Excluir plano](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-plans-planid-typeid.md) - [Listar assinaturas](https://developers.celcoin.com.br/reference/get_baas-v1-cash-subscriptions.md) - [Criar Assinatura com ou sem plano](https://developers.celcoin.com.br/reference/post_baas-v1-cash-subscriptions.md) - [Criar Assinatura Manual](https://developers.celcoin.com.br/reference/post_baas-v1-cash-subscriptions-manual.md) - [Editar pagamento da assinatura/contrato](https://developers.celcoin.com.br/reference/editar-pagamento-assinatura-contrato.md) - [Editar informações da assinatura/contrato](https://developers.celcoin.com.br/reference/put_baas-v1-cash-subscriptions-manual-subscriptionid-typeid.md) - [Capturar transação](https://developers.celcoin.com.br/reference/put_baas-v1-cash-subscriptions-manual-transactionid-typeid-capture.md) - [Adicionar transação](https://developers.celcoin.com.br/reference/post_baas-v1-cash-transactions-subscriptionid-typeid-add.md) - [Editar transação](https://developers.celcoin.com.br/reference/put_baas-v1-cash-transactions-transactionid-typeid.md) - [Cancelar uma transação](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-transactions-transactionid-typeid.md) - [Retentar cobrança no cartão](https://developers.celcoin.com.br/reference/put_baas-v1-cash-transactions-transactionid-typeid-retry.md) - [Estornar cobrança no cartão](https://developers.celcoin.com.br/reference/put_baas-v1-cash-transactions-transactionid-typeid-reverse.md) - [Capturar cobrança no cartão](https://developers.celcoin.com.br/reference/put_baas-v1-cash-transactions-transactionid-typeid-capture.md) - [Cancelar Assinatura/Contrato](https://developers.celcoin.com.br/reference/delete_baas-v1-cash-subscriptions-subscriptionid-typeid.md) - [Listar chargebacks](https://developers.celcoin.com.br/reference/get_baas-v1-cash-chargebacks.md) - [Enviar documentação](https://developers.celcoin.com.br/reference/put_baas-v1-cash-chargebacks-chargebackid.md) - [Desistir de disputa](https://developers.celcoin.com.br/reference/put_baas-v1-cash-chargebacks-lose-chargebackid.md) - [Simular Chargeback](https://developers.celcoin.com.br/reference/post_baas-v1-cash-chargeback-simulate.md) - [Cadastrar Webhook](https://developers.celcoin.com.br/reference/put_baas-v1-cash-webhooks.md) - [Listar taxas](https://developers.celcoin.com.br/reference/get_baas-v1-cash-company-fees.md) - [Listar transações](https://developers.celcoin.com.br/reference/get_baas-v1-cash-transactions.md) - [Consulta de Valores Elegíveis a Antecipação](https://developers.celcoin.com.br/reference/listagem-recebiveis.md): Retorna a lista paginada de recebíveis (transações) de uma empresa, incluindo informações de antecipação. - [Simular antecipação de recebíveis.](https://developers.celcoin.com.br/reference/post_baas-v1-cash-companies-numberaccount-simulation-antecipation-receivables.md): Cria e executa de forma síncrona a simulação de antecipação. Consulta as transações elegíveis, calcula os valores e persiste o resultado. **Janela de execução:** somente entre **07h00 e 22h59 (America/Sao_Paulo)**, independente do timezone do servidor. - [Efetiva o pagamento de uma simulação de antecipação.](https://developers.celcoin.com.br/reference/post_baas-v1-cash-companies-numberaccount-simulation-antecipation-payment-idrequest.md): Atua como proxy à API do subacquirer (`POST /antecipate-releases`), enviando as releases e a taxa da simulação. Em caso de sucesso, atualiza `statusSimulation` para `PAYED`. Se o subacquirer retornar erro, o status **não** é atualizado e a exceção é propagada. - [Lista simulações da company de forma paginada.](https://developers.celcoin.com.br/reference/get_baas-v1-cash-companies-numberaccount-simulation-antecipation-receivables.md): Retorna lista paginada das simulações da company autenticada, ordenadas por `simulationDay DESC`. O campo `allReleases` **não é retornado** neste endpoint por performance — use o endpoint de detalhe para obtê-lo. - [Consulta extrato de recebíveis](https://developers.celcoin.com.br/reference/extrato-de-recebiveis.md): Retorna as movimentações (Balances) e os totais (Totals) de uma empresa em um intervalo de datas. - [Pedido de consentimento de dados](https://developers.celcoin.com.br/reference/post_baas-v1-open-dat-consents.md): Cria novo pedido de consentimento - [Callback do consentimento ](https://developers.celcoin.com.br/reference/post_baas-v1-open-dat-consents-callback.md): Callback para o iniciador do serviço para obter `access_token`. Para executar esta chamada, extraia os parâmetros `code`, `state` e `id_token` da rota de aprovação do consentimento (campo `url`) e alimente o corpo da requisição com esses valores. Utilize o `access_token` do retorno para se autenticar e consumir os dados nas APIs de dados. - [Obtém a lista de contas consentidas pelo cliente](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-accounts.md): Método para obter a lista de contas depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `ACCOUNTS_READ` - [Obter detalhes de uma conta específica](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-accounts-accountid.md): Método para obter os dados de identificação da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. PERMISSÃO NECESSÁRIA: `ACCOUNTS_READ` - [Obtém os saldos da conta identificada por accountId](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-accounts-accountid-balances.md): Método para obter os saldos da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. PERMISSÃO NECESSÁRIA: `ACCOUNTS_BALANCES_READ` - [Obtém a lista de transações da conta identificada por accountId](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-accounts-accountid-transactions.md): Método para obter a lista de transações da conta de depósito à vista, poupança ou pagamento pré-paga identificada por accountId mantida pelo cliente na instituição transmissora. É permitida uma consulta máxima que se estenda em 12 meses no passado mais 12 meses no futuro. PERMISSÃO NECESSÁRIA: `ACCOUNTS_TRANSACTIONS_READ` - [Obtém os registros de identificação da pessoa natural](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-personal-identifications.md): Método para obter os registros de identificação da pessoa natural mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ` - [Obtém os dados de qualificação da pessoa natural](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-personal-qualifications.md): Método para obter registros de qualificação da pessoa natural mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_PERSONAL_QUALIFICATIONS_READ` - [Obtém os dados de relacionamento da pessoa natural com a instituição](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-personal-financial-relations.md): Método para obter registros de relacionamentos com a instituição financeira e de representantes da pessoa natural mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_PERSONAL_ADITTIONALINFO_READ` - [Obtém os registros de identificação da pessoa jurídica](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-business-identifications.md): Método para obter os registros de identificação da pessoa jurídica mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ` - [Obtém os dados de qualificação da pessoa jurídica](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-business-qualifications.md): Método para obter os registros de qualificação da pessoa jurídica mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_BUSINESS_QUALIFICATIONS_READ` - [Obtém os dados de relacionamento da pessoa jurídica com a instituição](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-customers-business-financial-relations.md): Método para obter registros de relacionamentos com a instituição financeira e de representantes da pessoa jurídica mantidos na instituição transmissora. PERMISSÃO NECESSÁRIA: `CUSTOMERS_BUSINESS_ADITTIONALINFO_READ` - [Obtém a lista de recursos consentidos pelo cliente](https://developers.celcoin.com.br/reference/get_api-open-keys-resources-v3-resources-1.md): Método para obter a lista de recursos mantidos pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `RESOURCES_READ` - [Obtém lista de investimentos em renda fixa bancária](https://developers.celcoin.com.br/reference/get_api-open-keys-bank-fixed-incomes-v1-investments-1.md): Obtém a lista de operações de Renda Fixa Bancária mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento PERMISSÃO NECESSÁRIA: `BANK_FIXED_INCOMES_READ` - [Obtém detalhes de um investimento em renda fixa bancária](https://developers.celcoin.com.br/reference/get_api-open-keys-bank-fixed-incomes-v1-investments-investmentid-1.md): Obtém os dados da operação de Renda Fixa Bancária identificada por investmentId. PERMISSÃO NECESSÁRIA: `BANK_FIXED_INCOMES_READ` - [Obtém saldos de um investimento em renda fixa bancária](https://developers.celcoin.com.br/reference/get_api-open-keys-bank-fixed-incomes-v1-investments-investmentid-balances-1.md): Obtém a posição da operação de Renda Fixa Bancária identificada por investmentId. Nos casos em que não houver posição para o investimento, ou seja, quantidade de ativos e valores monetários zerados, mas o mesmo ainda estiver no prazo de exposição (até 12 meses após a última movimentação), deve se retornar status code 200 e para o payload de retorno considerar os valores abaixo. Campos não obrigatórios não devem ser retornados: Valores monetários: 0.00 Quantidade de ativos: 0.00 Data e hora da última posição: mesmo conteúdo do campo requestDateTime PERMISSÃO NECESSÁRIA: `BANK_FIXED_INCOMES_READ` - [Obtém transações de um investimento em renda fixa bancária](https://developers.celcoin.com.br/reference/get_api-open-keys-bank-fixed-incomes-v1-investments-investmentid-transactions-1.md): Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId. PERMISSÃO NECESSÁRIA: `BANK_FIXED_INCOMES_READ` - [Obtém lista de investimentos em renda fixa de crédito](https://developers.celcoin.com.br/reference/get_api-open-keys-credit-fixed-incomes-v1-investments-1.md): Obtém a lista de operações de Renda Fixa Crédito mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `CREDIT_FIXED_INCOMES_READ` - [Obtém detalhes de um investimento em renda fixa de crédito](https://developers.celcoin.com.br/reference/get_api-open-keys-credit-fixed-incomes-v1-investments-investmentid-1.md): Obtém os dados da operação de Renda Fixa Crédito identificada por investmentId. PERMISSÃO NECESSÁRIA: `CREDIT_FIXED_INCOMES_READ` - [Obtém lista de investimentos em renda variável](https://developers.celcoin.com.br/reference/get_api-open-keys-variable-incomes-v1-investments-1.md): Obtém a lista de operações de Renda Variável mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `VARIABLE_INCOMES_READ` - [Obtém detalhes de uma nota de corretagem](https://developers.celcoin.com.br/reference/get_api-open-keys-variable-incomes-v1-investments-investmentid-broker-note-brokernoteid-1.md): Obtém as informações da nota de negociação identificado nas movimentações de compra e venda de ativos em bolsa. O brokerNoteId é enviado nos movimentos de compra ou venda de ativos e deve ser passada como parâmetro de entrada no endpoint “Nota de Negociação”. Como conteúdo do campo brokerNoteId é esperado que a transmissora gere um identificar único, imutável, para cada número (natural) de nota de negociação. PERMISSÃO NECESSÁRIA: `VARIABLE_INCOMES_READ` - [Obtém lista de investimentos em títulos do tesouro](https://developers.celcoin.com.br/reference/get_api-open-keys-treasure-titles-v1-investments-1.md): Obtém a lista de operações de Títulos do Tesouro Direto mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `TREASURE_TITLES_READ` - [Obtém lista de investimentos em fundos](https://developers.celcoin.com.br/reference/get_api-open-keys-funds-v1-investments-1.md): Obtém a lista de operações de Fundos de Investimento mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `FUNDS_READ` - [Obtém os dados dos contratos de financiamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-financings-contracts.md): Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `FINANCINGS_READ` - [Obtém detalhes de um contrato de financiamento identificado por contractId](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-financings-contracts-contractid.md): Método para obter os dados do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora PERMISSÃO NECESSÁRIA: `FINANCINGS_READ` - [Obtém cronograma de parcelas de um financiamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-financings-contracts-contractid-scheduled-instalments.md): Método para obter os dados do cronograma de parcelas do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora PERMISSÃO NECESSÁRIA: `FINANCINGS_SCHEDULED_INSTALMENTS_READ` - [Obtém histórico de pagamentos de um financiamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-financings-contracts-contractid-payments.md): Método para obter os dados de pagamentos do contrato de financiamento identificado por contractId mantido pelo cliente na instituição transmissora PERMISSÃO NECESSÁRIA: `FINANCINGS_PAYMENTS_READ` - [Obtém a lista de garantias vinculadas ao contrato de financiamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-financings-contracts-contractid-warranties.md): Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno. PERMISSÃO NECESSÁRIA: `FINANCINGS_WARRANTIES_READ` - [Obtém lista de contratos de empréstimo](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-loans-contracts.md): Método para obter a lista de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento. PERMISSÃO NECESSÁRIA: `LOANS_READ` - [Obtém detalhes de um contrato de empréstimo](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-loans-contracts-contractid.md): Método para obter os dados do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. PERMISSÃO NECESSÁRIA: `LOANS_READ` - [Obtém cronograma de parcelas de um empréstimo](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-loans-contracts-contractid-scheduled-instalments.md): Método para obter os dados do cronograma de parcelas do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora PERMISSÃO NECESSÁRIA: `LOANS_SCHEDULED_INSTALMENTS_READ` - [Obtém histórico de pagamentos de um empréstimo](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-loans-contracts-contractid-payments.md): Método para obter os dados de pagamentos do contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora PERMISSÃO NECESSÁRIA: `LOANS_PAYMENTS_READ` - [Obtém garantias de um contrato de empréstimo](https://developers.celcoin.com.br/reference/get_baas-v1-open-dat-loans-contracts-contractid-warranties.md): Método para obter a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId mantido pelo cliente na instituição transmissora. Para os produtos que não possuam garantias deve-se retornar HTTP Status 200 com o objeto “data” vazio, sem nenhum atributo interno. PERMISSÃO NECESSÁRIA: `LOANS_WARRANTIES_READ` - [Criar conta de crédito](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-applications-applicationid-accounts-1.md): Cria uma nova conta de credor para a aplicação. A conta será utilizada para receber pagamentos e deve incluir informações bancárias válidas, incluindo número da conta, agência e dados bancários. Há validação de duplicados, antes da criação. - [Listar contas de crédito](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-accounts-1.md): Lista todas as contas de crédito associadas a uma determinada aplicação. Os resultados incluem metadados relevantes da conta, como números de conta, tipos e instituições bancárias associadas. - [Buscar dados de uma conta de crédito](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-accounts-accountid-1.md): Recupera informações detalhadas sobre uma conta de crédito específica por meio de seu identificador exclusivo. Retorna dados completos da conta, incluindo informações do proprietário, detalhes da conta de pagamento e metadados associados. - [Deletar uma conta de crédito](https://developers.celcoin.com.br/reference/delete_baas-v1-open-itp-applications-applicationid-accounts-accountid-1.md): Remove permanentemente uma conta de de crédito específica do aplicativo. Esta ação não pode ser desfeita. A conta deve existir e pertencer ao aplicativo especificado antes de poder ser excluída. - [Adicionar URL de redirecionamento](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-applications-applicationid-redirects-1.md): Método para adicionar uma nova URL de redirecionamento para uma aplicação - [Listar URLs de redirecionamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-redirects-1.md): Método para listar as URLs de redirecionamento de uma aplicação - [Buscar dados de uma URL de redirecionamento](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-redirects-redirectid-1.md): Método para obter uma URL de redirecionamento específica de uma aplicação - [Deletar URL de redirecionamento](https://developers.celcoin.com.br/reference/delete_baas-v1-open-itp-applications-applicationid-redirects-redirectid-1.md): Método para remover uma URL de redirecionamento de uma aplicação - [Cadastrar webhook da aplicação](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-applications-applicationid-webhooks-1.md): Cria uma configuração de webhook para uma apliucação para receber notificações sobre eventos de pagamento e alterações no status da jornada. Suporta vários métodos de autenticação, incluindo chave API, autenticação básica e token de portador. - [Obter .](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-webhooks-1.md): Método para . - [Obter .](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-webhooks-id-1.md): Método para . - [Obter .](https://developers.celcoin.com.br/reference/delete_baas-v1-open-itp-applications-applicationid-webhooks-id-1.md): Método para . - [Criar ou atualizar configuração da aplicação](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-applications-applicationid-settings-1.md): Cria ou atualiza uma configuração para uma aplicação. As configurações podem incluir favicon, cor primária, alias de jornada, provedor de identidade e visibilidade do botão de inscrição. Isso permite a personalização da aparência e do comportamento do aplicativo. - [Obtain .](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-applications-applicationid-settings-1.md): Method for . - [Lista as detentoras participantes do ITP.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-participants-brands-1.md): Método para retornar a lista de detentoras participantes do ITP. O retorno é paginado e pode ser filtrado pelo nome da detentora. - [Obtém os detalhes de uma detentora participante do ITP.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-participants-brands-brandid-1.md): Método para retorno dos detalhes de uma detentora participante do ITP. - [Criar uma sessão de jornada ITP](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payments-journeys-sessions-1.md): Método para criar uma sessão de jornada ITP. Para escolher o tipo da jornada, é necessário enviar o journeyID. - [Listar sessões de jornada](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-payments-journeys-sessions-1.md): Método para listar todas as sessões de uma viagem criada por um aplicativo. - [Buscar dados de uma sessão de jornada](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-payments-journeys-sessions-id-1.md): Método que retorna uma sessão de uma jornada a partir de seu ID. - [Creates an ITP journey session for enrollment.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-enrollments-journeys-sessions-1.md): Method for creating an ITP journey session for enrollment purposes. To choose the journey, the ID of a journey must be passed. The available journeys can be checked by the endpoint `GET /baas/v1/open/itp/payments/journeys-sessions/{id}`. - [Lists enrollment journey sessions.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-enrollments-journeys-sessions-1.md): Method for listing all enrollment journey sessions created by an application. The ID of the journey must be passed for the sessions to be listed. - [Search for an enrollment journey session.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-enrollments-journeys-sessions-id-1.md): Method that returns an enrollment journey session from its ID. - [Updates the enrollment journey session.](https://developers.celcoin.com.br/reference/patch_baas-v1-open-itp-enrollments-journeys-sessions-id-1.md): Method to update the enrollment journey session. At this point it is possible to update only the status, being used for the cancellation of the session. - [Search for an enrollment journey session, using as reference the external ID sent in the creation of the session.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-enrollments-journeys-sessions-external-externalid.md): Method that returns an enrollment journey session from its ID. The externalId is the property passed in the request for the creation of the journey session. - [Creates an enrollment payment initiation.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-enrollments-payment-initiation-1.md): Method for creating an enrollment payment initiation. - [Lists enrollment payment initiations.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-enrollments-payment-initiation-1.md): Method for listing enrollment payment initiations. - [Gets an enrollment payment initiation.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-payment-initiation-itp-payment-id-1.md): Method for getting an enrollment payment initiation. - [Updates an enrollment payment initiation.](https://developers.celcoin.com.br/reference/patch_baas-v1-open-itp-payment-initiation-itp-payment-id-1.md): Method for updating an enrollment payment initiation. - [Gets enrollment FIDO registration options.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-enrollments-payment-initiation-itp-enrollment-id-fido-registration-options-1.md): Method for getting enrollment FIDO registration options. - [Completes enrollment FIDO registration.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payment-initiation-id-fido-registration-1.md): Object containing the response from creating a new FIDO2 credential. - [Gets enrollment FIDO sign options.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payment-initiation-itp-enrollment-id-fido-sign-options-1.md): Method for getting enrollment FIDO sign options. - [Authorizes enrollment consent.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payment-initiation-itp-enrollment-id-authorise-1.md): Object containing the response from creating a new FIDO2 credential. - [Payment Processing.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payment-initiation-1.md): Method for Payment Processing. - [Payment Processing.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-payment-initiation-1.md): Method for Payment Processing. - [Create end user managament session with url.](https://developers.celcoin.com.br/reference/post_baas-v1-open-itp-payment-initiation-management-session-1.md): Method for Create end user managament session with url. - [Get end user management session data.](https://developers.celcoin.com.br/reference/get_baas-v1-open-itp-payment-initiation-management-session-1.md): Method for getting end user management session data. - [Cadastrar Webhook - Basic](https://developers.celcoin.com.br/reference/cadastrar-webhook.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Cadastrar Webhook - JWT](https://developers.celcoin.com.br/reference/cadastrar-webhook-1.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Consultar Webhooks cadastrados](https://developers.celcoin.com.br/reference/consultar-webhooks-cadastrados.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Editar Webhook cadastrado](https://developers.celcoin.com.br/reference/editar-webhook-cadastrado.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Excluir Webhook cadastrado](https://developers.celcoin.com.br/reference/excluir-webhook-cadastrado.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Consultar lista de eventos enviados pelo webhook](https://developers.celcoin.com.br/reference/consultar-lista-de-eventos-enviados-pelo-webhook.md) - [Consultar Templates de Webhooks](https://developers.celcoin.com.br/reference/consultar-templates-de-webhooks.md) - [Consultar quantidade de webhooks enviados.](https://developers.celcoin.com.br/reference/consultar-quantidade-de-webhooks-enviados.md) - [Consultar detalhes dos webhooks enviados.](https://developers.celcoin.com.br/reference/consultar-detalhes-dos-webhooks-enviados.md) - [Reenvio de webhooks pendentes](https://developers.celcoin.com.br/reference/reenvio-de-webhooks-pendentes.md) - [Bloqueio e desbloqueio de saldo (somente Core Banking)](https://developers.celcoin.com.br/reference/bloquei-e-desbloqueio-de-saldo.md) - [Bloqueio de saldo](https://developers.celcoin.com.br/reference/bloqueio-de-valores.md): Confira nosso tutorial -> https://developers.celcoin.com.br/update/docs/bloqueio-de-saldo - [Desbloqueio de saldo](https://developers.celcoin.com.br/reference/desbloqueio-de-saldo.md) - [MED 2.0](https://developers.celcoin.com.br/reference/med-20-1.md) - [Criar recuperação de valores](https://developers.celcoin.com.br/reference/criar-recuperação-de-valores-1.md): Confira nosso tutorial -> [Criar recuperação de valores](https://developers.celcoin.com.br/update/docs/criar-recupera%C3%A7%C3%A3o-de-valores-1) - [Consulta recuperação de valores](https://developers.celcoin.com.br/reference/consulta-recuperação-de-valores-1.md) - [Cancelar recuperação de valores](https://developers.celcoin.com.br/reference/cancelar-recuperação-de-valores-1.md) - [Fechar solicitação de recuperação de valores](https://developers.celcoin.com.br/reference/fechar-solicitação-de-recuperação-de-valores.md) - [Retornar informações do seu saldo atual](https://developers.celcoin.com.br/reference/retorna-as-informações-do-seu-saldo-atual.md): Esta API retorna informações pertinentes ao saldo de sua conta. Todos os dias, a Celcoin realiza a conciliação dos pagamentos. Para identificar que esse processo está em andamento, criamos o atributo 'reconcileExecuting', onde são retornados os valores 'S' ou 'N'. Caso seja apresentado 'S', significa que o processo está em execução, portanto, recomendamos que os valores dos atributos 'balance', 'credit' e 'consumed' sejam desconsiderados, pois, como a conciliação está em execução, se usados os valores para conciliação em sua aplicação, provavelmente ocorrerão erros no batimento - [Recuperar detalhes de uma transação](https://developers.celcoin.com.br/reference/recupere-detalhes-de-uma-transação.md): Essa api possibilita que seja recuperado detalhes de uma transação por meio de seu transactionId ou pela data da transação e identificadores externos - [Obter comprovante de uma transação](https://developers.celcoin.com.br/reference/obter-um-comprovante-de-uma-transação.md): É possível realizar consulta de comprovantes até 150 dias após a efetivação da transação. - [Listar convênios](https://developers.celcoin.com.br/reference/obtenha-a-lista-de-convênios.md): Com essa API é possível listar todos os convênios de concessionárias e tributos que estão disponíveis para pagamento na base da Celcoin. Além de ser possível saber à quais localidades eles pertencem. - [Retorna a saúde de um determinado tipo de transação](https://developers.celcoin.com.br/reference/retorna-a-saúde-de-um-determinado-tipo-de-transação.md): Tipos de transações aceitas: CONSULTADADOSCONTA para transações /Billpayments/Authorize RECEBERCONTA para transações /Billpayments RECARGA para transações /Topups Periodo: 0 para 10 minutos 1 para 1 hora 2 para 3 horas 3 para 24 horas - [Listar bancos](https://developers.celcoin.com.br/reference/gere-a-lista-de-bancos.md) - [Listar transações pendentes](https://developers.celcoin.com.br/reference/lista-de-transações-pendentes.md): Essa API disponibiliza uma lista de todas as transações que foram efetivadas, mas que não foram confirmadas. Ou seja, as transações que estão pendentes - [Consultar extrato consolidado](https://developers.celcoin.com.br/reference/consultar-extrato-consolidado.md): Essa API possibilita que seja realizada a consulta de extrato consolidado. Para mais informações de como realizar a implementação dessa API, criamos este [artigo](https://developers.celcoin.com.br/docs/sobre-api-de-extrato-consolidado). Para saber mais sobre os erros que essa API retorna ao realizar a consulta, clique [aqui](https://developers.celcoin.com.br/docs/tabela-de-erros-conciliacao#consulta-extrato-consolidado) - [Buscar tipos de arquivos](https://developers.celcoin.com.br/reference/buscar-tipos-de-arquivos.md): Essa API possibilita a consulta do extrato consolidado. Para mais informações, criamos este [artigo](https://developers.celcoin.com.br/reference/extrato-consolidado).Para saber mais sobre os erros que essa API retorna ao realizar a consulta, clique [aqui](https://developers.celcoin.com.br/docs/tabela-de-erros-conciliacao) - [Extrair arquivo](https://developers.celcoin.com.br/reference/extrair-arquivo.md): Essa API possibilita que seja realizada a consulta e extração de arquivo de conciliação. Para mais informações de como realizar a implementação dessa API, criamos este [artigo](https://developers.celcoin.com.br/docs/sobre-api-de-concilia%C3%A7%C3%A3o). Para saber mais sobre os erros que essa API retorna ao realizar a consulta, clique [aqui](https://developers.celcoin.com.br/docs/tabela-de-erros-conciliacao) - [Extrato consolidado](https://developers.celcoin.com.br/reference/extrato-consolidado.md): Essa API possibilita que seja realizada a consulta de tipos de arquivos de conciliação. Para mais informações de como realizar a implementação dessa API, criamos este [artigo](https://developers.celcoin.com.br/docs/sobre-api-de-concilia%C3%A7%C3%A3o).Para saber mais sobre os erros que essa API retorna ao realizar a consulta, clique [aqui](https://developers.celcoin.com.br/docs/tabela-de-erros-conciliacao) - [Configurar webhooks](https://developers.celcoin.com.br/reference/configurar-webhooks.md): Essa API permite realizar a configuração da(s) URL(s) que receberá(ão) as atualizações de status do cadastro, exclusão e de boletos. Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#configurar-webhooks) e saiba como realizar a implementação dessa API. Para atualizar a URL cadastrada, basta realizar uma nova requisição, pois ela irá sobrescrever a configuração anterior. - [Consultar webhooks](https://developers.celcoin.com.br/reference/consultar-webhooks.md): Essa API permite consultar a configuração da(s) URL(s) que receberá(ão) as atualizações de status do cadastro, exclusão e de boletos. Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#consultar-webhooks) e saiba como realizar a implementação dessa API. - [Cadastrar usuário](https://developers.celcoin.com.br/reference/cadastrar-usuário.md): Essa API permite realizar o cadastro de um usuário no DDA para recebimento das notificações de boletos gerados em seu documento (CPF/CNPJ). Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#cadastrar-usu%C3%A1rio) e saiba como realizar a implementação dessa API. Em ambiente de teste (sandbox) pode ser usado qualquer documento, mas o tempo de retorno dos webhooks pode demorar. Se quiser simular o retorno dos webhooks de forma rápida, utilize nossos dados armazenados previamente. Para isso, basta usar o CPF 71929784007 para simular um cadastro com sucesso ou o CPF 26817625025 para simular um cadastro com erro. Para testar as notificações de boletos, basta informar qualquer CNPJ ou CPF cadastrados (status created) anteriormente (com exceção dos CPFs armazenados, citados anteriormente) na API de boletos. - [Excluir usuário](https://developers.celcoin.com.br/reference/excluir-usuário.md): Essa API permite realizar a exclusão de um usuário do DDA. Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#excluir-usu%C3%A1rio) e saiba como realizar a implementação dessa API. Em ambiente de teste (sandbox) pode ser usado qualquer documento que tiver sido registrado anteriormente, mas o tempo de retorno dos webhooks pode demorar. Se quiser simular o retorno dos webhooks de forma rápida, utilize nossos dados armazenados previamente. Para isso, basta usar o CPF 71929784007 para simular uma exclusão com sucesso ou o CPF 26817625025 para simular uma exclusão com erro. - [Gerar boleto](https://developers.celcoin.com.br/reference/gerar-boleto.md): Essa API permite gerar boletos para um usuário cadastrado no DDA, apenas em sandbox. Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#excluir-usu%C3%A1rio) e saiba como realizar a implementação dessa API.O limite é de 20 documentos por requisição. Pode ser enviado o mesmo documento caso precise gerar mais de uma notificação por CPF/CNPJ. - [Consultar Débitos de um veículo](https://developers.celcoin.com.br/reference/criar-pedido-assíncrono-de-uma-de-débito-veiculares.md): Essa API irá retornar informações de um débito veicular a partir dos dados do veículo e proprietário. Basicamente você irá passar as informações e a Celcoin irá realizar a consulta e retornará após alguns segundos via webhook. Para mais informações de como realizar a implementação dessa API criamos o artigo a [**seguir**](https://developers.celcoin.com.br/docs/sobre-a-api-de-auto#executar-o-pagamento-de-um-d%C3%A9bito-veicular). Para testes em ambiente de sandbox recomendamos que seja utilizado a massa de teste disponibilizada neste [**link**](https://docs.google.com/spreadsheets/d/1y_vPJ6_yOIm6JRsXIz9On6HUBMKyFxrm/edit?usp=sharing&ouid=111561115532951179309&rtpof=true&sd=true). Criamos uma tabela que contém todos os erros que essa api pode retornar, recomendamos a leitura do da mesma para realizar a implementação dessa [**api**](https://developers.celcoin.com.br/docs/tabela-de-erros-3). - [Consultar Dados Enriquecidos de um Veículo](https://developers.celcoin.com.br/reference/consultar-dados-enriquecidos-de-um-veiculo.md): Essa API irá retornar os dados básicos do veículo (UF, Renavam, Documento do Proprietário, Modelo, Ano e Cor). Com esses dados em mãos será possível realizar uma consulta de Débitos Veiculares nos órgãos competentes. A seguir a massa de teste: https://docs.google.com/spreadsheets/d/1y_vPJ6_yOIm6JRsXIz9On6HUBMKyFxrm/edit?gid=1906373398#gid=1906373398 - [Realizar pagamento](https://developers.celcoin.com.br/reference/cria-um-pedido-de-pagamento-assíncrono-para-uma-lista-de-débitos.md): Essa API possibilita que seja realizado a solicitação de um ou vários pagamentos de forma assíncrona, sendo assim, após enviar a requisição enviaremos um gatilho no formato JSON em seu webhook. Para mais informações de como realizar a implementação dessa API criamos esse [artigo](https://developers.celcoin.com.br/docs/sobre-a-api-de-auto#executar-o-pagamento-de-um-d%C3%A9bito-veicular). Criamos uma tabela que contém todos os erros que essa api pode retornar, recomendamos a leitura do da mesma para realizar a implementação dessa [**api**] (https://developers.celcoin.com.br/docs/tabela-de-erros-3#api-de-pagamentos-de-debitos-veiculares). - [Registrar URL para recebimento de notificações via Webhook](https://developers.celcoin.com.br/reference/registra-uma-url-para-recebimento-de-notificações-via-webhook.md): Essa API realiza a configuração de um webhook para recebimentos dos gatilhos disparados pela Celcoin, informando sobre os débitos de um veiculo.Para mais informações de como realizar a implementação dessa API criamos esse [artigo](https://developers.celcoin.com.br/docs/sobre-a-api-de-auto#configurando-webhook-gatilho)Ao realizar a configuração da url a Celcoin irá realizar uma requisição em seu endpoint para validar se ele funciona, retornando 200, vamos apresentar sucesso, caso contrário vamos avisar que um retorno inesperado aconteceu. Para atualização da URL será necessário repetir a etapa de registro. - [Registrar Webhook Com Token - JWT](https://developers.celcoin.com.br/reference/registrar-webhook-com-token-jwt.md): A API realiza a configuração de um webhook através de token (JWT), para recebimentos dos gatilhos disparados pela Celcoin, informando sobre os débitos de um veiculo. Com isso garantiremos uma maior segurança e confiabilidade nas trocas de mensagem do produto. Para mais informações de como realizar a implementação dessa API criamos esse [artigo](https://developers.celcoin.com.br/docs/cadastro-de-webhook-com-autentica%C3%A7%C3%A3o-via-token-jwt) Ao realizar a configuração da url a Celcoin irá realizar uma requisição em seu endpoint para validar se ele funciona, retornando 200, vamos apresentar sucesso, caso contrário vamos avisar que um retorno inesperado aconteceu. Para atualização da URL será necessário repetir a etapa de registro. - [Retornar URL registrada para recebimento de notificações via Webhook](https://developers.celcoin.com.br/reference/retorna-a-url-registrada-para-recebimento-de-notificações-via-webhook.md): É possível verificar a última URL registrada pelo cliente para recebimento de notificações via Webhook. - [Inclusão de Carteira](https://developers.celcoin.com.br/reference/inclusao-carteira.md): Esta API permite que o cliente crie uma Carteira (Wallet) para que possa utilizá-la no momento da emissão de um boleto. Com ela, será possível gerenciar melhor boletos de acordo com suas características. - [Consulta de Carteira por código/ID](https://developers.celcoin.com.br/reference/consulta-carteira-id.md): Esta API permite que o cliente busque uma única Carteira através do código ou pelo ID único gerado, de forma que possa consultar os dados de criação e identificação. - [Alteração de Carteira](https://developers.celcoin.com.br/reference/alteracao-carteira.md): Esta API permite que o cliente altere o código ou o nome de uma Carteira específica através do ID único gerado no momento da criação. - [Exclusão de carteira](https://developers.celcoin.com.br/reference/exclusao-carteira.md): Essa API permite a deleção de carteira - [Consulta de todas as Carteiras](https://developers.celcoin.com.br/reference/consulta-todas-carteiras.md): Esta API permite que o cliente busque todas as Carteiras criadas, de forma que possa consultar os dados de criação e identificação de cada uma. - [Inclusão de Beneficiário](https://developers.celcoin.com.br/reference/inclusao-beneficiario.md): Esta API permite que o cliente inclua um Beneficiário, de forma que, possa declará-los como Beneficiários Originais ou Finais no momento da emissão do boleto. - [Consulta de Beneficiário](https://developers.celcoin.com.br/reference/consulta-beneficiario.md): Esta API permite que o cliente consulte um Beneficiário, podendo verificar se ele já foi incluído anteriormente e qual o seu status, visando a inclusão dele no momento da emissão. - [Emissão de Boleto](https://developers.celcoin.com.br/reference/emissao-boleto.md): Esta API permite que o cliente emita um boleto, podendo atrelar ou não à uma Carteira (Wallet) criada anteriormente. Nesta API, poderá configurar parâmetros como: Beneficiário Original, Beneficiário Final, Pagador, valor nominal, data de vencimento, desconto, juros, multa, entre outros. - [Consulta de boletos com paginação](https://developers.celcoin.com.br/reference/consulta-boleto-paginacao.md): Esta API permite que o cliente consulte um boleto emitido anteriormente, podendo verificar seu status e as demais informações geradas no momento da emissão. - [Consulta de boleto por Id](https://developers.celcoin.com.br/reference/consulta-boleto-id.md) - [Inclusão de Baixa (Cancelamento)](https://developers.celcoin.com.br/reference/inclusao-baixa.md): Esta API permite que o cliente inclua uma baixa de um boleto específico, fazendo com que ele fique impossibilitado de receber pagamentos. - [Consulta de Baixa](https://developers.celcoin.com.br/reference/consulta-baixa.md): Esta API permite que o cliente consulte uma inclusão de baixa realizada anteriormente, podendo verificar o status da baixa e as demais informações geradas no momento de sua inclusão. - [Consultar os dados de uma conta](https://developers.celcoin.com.br/reference/pagamento-de-contas-2.md): Essa API permite a consulta de uma conta (boleto) para validação dos seus dados. Veja o nosso [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#consultar-os-dados-de-uma-conta-authorize) e saiba como realizar a implementação dessa API. Entenda quais são os erros que essa API poderá retornar ao realizar a consulta de um pagamento, [clique aqui](https://developers.celcoin.com.br/docs/tabelas-de-erros#tabela-de-consulta-de-um-pagamento-atrav%C3%A9s-do-c%C3%B3digo-de-barras-ou-linha-digit%C3%A1vel). Para testes em ambiente de sandbox recomendamos que seja utilizado a nossa [massa de testes](https://developers.celcoin.com.br/page/tabela-de-massa-de-teste-para-pagamentos-de-ficha-de-compensa%C3%A7%C3%A3o). - [Reservar saldo para efetuar o pagamento de uma conta](https://developers.celcoin.com.br/reference/efetuar-um-pagamento.md): Realiza a reserva de um valor da sua conta Celcoin para a execução de um pagamento. Veja o nosso [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#reservar-saldo-para-efetuar-o-pagamento-de-uma-conta-billpayments) e saiba como realizar a implementação dessa API. Entenda quais são os erros que essa API poderá retornar ao realizar a reserva de saldo, [clique aqui](https://developers.celcoin.com.br/docs/tabelas-de-erros#tabela-de-erros-da-api-de-reserva-de-saldo) - [Confirmar o pagamento de uma conta](https://developers.celcoin.com.br/reference/confirmar-o-pagamento-de-uma-conta.md): Essa API efetua o pagamento de uma conta. Veja o nosso [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#confirmar-o-pagamento-de-uma-conta) e saiba como realizar a implementação dessa API. Entenda quais são os erros que essa API poderá retornar ao realizar a confirmação do pagamento, [clique aqui](https://developers.celcoin.com.br/docs/tabelas-de-erros#tabela-de-erros-da-api-de-confirma%C3%A7%C3%A3o-de-pagamento). - [Consultar status de uma transação](https://developers.celcoin.com.br/reference/consultar-informações-de-um-pagamento.md): Essa API disponibiliza informações de um pagamento a partir de alguns campos. Criamos um [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#consultar-informa%C3%A7%C3%B5es-de-um-pagamento) que explica como usar essa API. - [Consultar ocorrências de um pagamento](https://developers.celcoin.com.br/reference/consulta-lista-de-ocorrências.md): Às vezes ao realizar o pagamento de uma conta o beneficiário, entidade final que está recebendo o dinheiro, rejeita alguns pagamentos, nesses casos a Celcoin ao identificar essa situação, devolve o dinheiro para conta proprietária do seu cliente e disponibiliza os pagamentos que foram rejeitados nessa apí. Criamos um [artigo](https://developers.celcoin.com.br/docs/devolu%C3%A7%C3%A3o-de-pagamento-de-conta) que explica como usar essa api. - [Cancelar uma reserva realizada](https://developers.celcoin.com.br/reference/cancela-a-transação-de-pagamento-de-contas-efetuada.md): Essa API realiza o cancelamento de uma reserva realizada indevidamente. Para mais informações de como realizar a implementação dessa API, criamos o [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1) - [Reverter uma transação de pagamento de contas efetuada](https://developers.celcoin.com.br/reference/estornar-uma-transação-de-pagamento-de-contas-efetuada.md): Essa API possibilita reverter um pagamento de conta realizado desde de que ele esteja fora de sua janela de pagamento. Para mais informações criamos o [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#estornar-uma-transa%C3%A7%C3%A3o-de-pagamento-de-contas-efetuada) - [Pagamentos - Obter comprovante de uma transação](https://developers.celcoin.com.br/reference/obter-um-comprovante-de-uma-transação-1-1.md): É possível realizar consulta de comprovantes até 150 dias após a efetivação da transação. - [Aceita uma recorrência](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-2.md) - [Aceita uma recorrência](https://developers.celcoin.com.br/reference/aceita-uma-recorrência-3.md) - [Recusa uma recorrência](https://developers.celcoin.com.br/reference/recusa-uma-recorrência-1.md) - [Busca recorrências por status com paginação](https://developers.celcoin.com.br/reference/busca-recorrências-por-status-com-paginação-1.md) - [Busca uma recorrência pelo ID](https://developers.celcoin.com.br/reference/busca-uma-recorrência-pelo-id-1.md) - [Cancelamento de Autorização](https://developers.celcoin.com.br/reference/cancelamento-de-autorização-1.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/reference/cancelamento-de-agendamento-1.md) - [Crie uma recorrência com a jornada 1](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-a-jornada-1-1.md) - [Crie uma recorrência com a jornada 2](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-a-jornada-2-1.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/reference/cancelamento-de-agendamento-3.md) - [Criar um QR Code dinâmico](https://developers.celcoin.com.br/reference/criar-um-qrcode-dinamico-dynamic.md): Essa API possibilita que seja criado um QR Code para cobranças dinâmicas imediatas e com valores pré-definidos. Com este endpoint, em uma chamada é realizado, automaticamente, o fluxo completo para criação de um QR Code: 1. endereçamento do QR Code (location); 2. criação da cobrança vinculada àquele QR Code (COB). - [Buscar dados de uma cobrança dinâmica](https://developers.celcoin.com.br/reference/buscar-dados-de-uma-cobranca-dinamica-dynamic.md): Busca de dados de uma cobrança dinamica por transctionId ou transactionIdentification ou clientRequestId. - [Atualizar QR Code dinâmico](https://developers.celcoin.com.br/reference/atualizar-um-qrcode-dinamico.md): Essa API possibilita que seja atualizado um QR Code para cobranças dinâmicas, ou seja que cobra de forma imediata e com valores pré-definidos. - [Recupera uma imagem base64 representando um QR Code dinâmico](https://developers.celcoin.com.br/reference/recupera-imagem-de-um-qrcode-dinamico.md) - [Carrega, valida e parseia o json do payload da URL](https://developers.celcoin.com.br/reference/carrega-valida-e-parseia-o-json-do-payload-da-url.md): Essa API realiza a consulta de um QR Code atrelado a uma cobrança imediata a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Deletar um QR Code dinâmico](https://developers.celcoin.com.br/reference/deletar-um-qrcode-dinamico.md) - [Criar um QR Code estático](https://developers.celcoin.com.br/reference/criar-um-qrcode-estatico.md): Essa API possibilita que seja criada um QR Code estático para cobranças Pix. - [Retornar dados de um QR Code estático.](https://developers.celcoin.com.br/reference/retorna-os-dados-de-um-qrcode-estatico.md) - [Recupera uma imagem base64 representando um QR Code estático](https://developers.celcoin.com.br/reference/recupera-imagem-de-um-qrcode-estatico.md) - [Retornar dados do QR Code estático e os pagamentos recebidos](https://developers.celcoin.com.br/reference/consultar-dados-do-qrcode-estatico-e-pagamentos-recebidos.md): ⚠️ O Endpoint dessa página está sendo revisto. Em breve disponibilizaremos novamente esse endpoint. - [Deleta um QR code estático](https://developers.celcoin.com.br/reference/deleta-um-qr-code-estático.md) - [Criar um QR Code (location)](https://developers.celcoin.com.br/reference/criar-um-qrcode-location.md): Essa API possibilita que seja realizado a criação de um QR Code para em seguida ser atrelado uma cobrança a ele, podendo ser com vencimento, ou imediata. - [Retorna os dados de um QR Code location](https://developers.celcoin.com.br/reference/retorna-dados-de-um-qrcode-location.md) - [Recupera uma imagem base64 representando um QR Code Location dinâmico](https://developers.celcoin.com.br/reference/recupera-imagem-de-um-qrcode-location-dinamico.md) - [Criar nova cobrança imediata](https://developers.celcoin.com.br/reference/criar-uma-cobranca-imediata.md): Essa API possibilita que seja criada uma cobrança imediata, vinculada a um QR Code já criado (location). - [Atualizar dados de uma cobrança imediata](https://developers.celcoin.com.br/reference/atualizar-dados-de-uma-cobranca-imediata.md): Essa API possibilita que seja atualizada uma cobrança imediata. - [Busca de dados de uma cobrança imediata](https://developers.celcoin.com.br/reference/buscar-dados-de-uma-cobranca-imediata-v2.md): Essa API possibilita a busca de dados de uma cobrança imediata (COB) a partir do transctionId, transactionIdentification ou clientRequestId. - [Desvincular cobrança imediata de um BRCode Location](https://developers.celcoin.com.br/reference/desvincular-cobranca-imediata-e-qrcode-location.md): Essa API desvincula uma cobrança de um QR Code, desta forma é possível utilizá-lo para realizar outra cobrança. - [Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)](https://developers.celcoin.com.br/reference/carrega-valida-e-analisa-uma-cobranca-imediata-cob.md): Essa API realiza a consulta de um QR Code atrelado a uma cobrança imediata a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Deletar uma cobrança imediata](https://developers.celcoin.com.br/reference/deletar-uma-cobranca-imediata.md) - [Criar cobrança com vencimento](https://developers.celcoin.com.br/reference/criar-cobranca-com-vencimento-cobv.md): Essa API possibilita que seja realizado o vinculo de um QR Code a uma cobrança com vencimento, multa, juros, ou abatimentos (COBV). - [Atualizar dados de uma cobrança com vencimento](https://developers.celcoin.com.br/reference/atualizar-dados-de-uma-cobranca-com-vencimento-cobv.md): Essa API possibilita que seja realizado a atualização do vencimento de um QR Code. - [Buscar dados de uma cobrança com vencimento](https://developers.celcoin.com.br/reference/buscar-uma-cobranca-com-vencimento-v2.md): Essa API possibilita a busca de dados de uma cobrança com vencimento (COBV) a partir do transctionId, transactionIdentification ou clientRequestId. - [Desvincular cobrança com vencimento de um QR Code location](https://developers.celcoin.com.br/reference/desvincular-cobranca-com-vencimento-e-qrcode-location.md) - [Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)](https://developers.celcoin.com.br/reference/carrega-valida-e-analisa-uma-cobranca-com-vencimento-cobv.md): Essa API realiza a consulta de um QR Code, atrelado a uma cobrança com vencimento, a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Deletar uma cobrança com vencimento](https://developers.celcoin.com.br/reference/deletar-uma-cobranca-com-vencimento-cobv.md): Usando o DELETE, o QR Code Location será automaticamente desvinculado da cobrança com vencimento. - [Consulta o status de um Recebimento Pix](https://developers.celcoin.com.br/reference/consulta-o-status-de-um-recebimento-pix.md): Endpoint destinado à consulta do status de qualquer recebimento Pix, através do endtoEndId, transactionId ou transactionIdBrCode - [Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)](https://developers.celcoin.com.br/reference/consulta-o-status-de-um-recebimento-pix-v2.md): Endpoint destinado à consulta do status de qualquer recebimento Pix, através do endtoEndId, transactionId ou transactionIdBrCode. Retornará além dos campos normais o clienteRequestId do QRCode e o status do Recebimento. - [Criar uma devolução de um recebimento Pix via TransactionId](https://developers.celcoin.com.br/reference/devolver-um-pagamento-pix-recebido.md): Essa API possibilita que seja realizada a devolução de um Pix recebido.Criamos um [artigo](https://developers.celcoin.com.br/docs/devolver-um-recebimento-pix) explicando como implementar essa api. - [Consulta o status de uma devolução de recebimento Pix criada](https://developers.celcoin.com.br/reference/consulta-status-de-devolucao.md): Endpoint destinado à consulta de status posterior ao recebimento de webhook ou em caso de muita demora para o recebimento da confirmação. - [Retornar informações do DICT utilizando uma chave cadastrada no Pix](https://developers.celcoin.com.br/reference/consulta-dados-bancarios-de-uma-chave-pix.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Realizar busca das estatísticas de chave ou de pessoa](https://developers.celcoin.com.br/reference/realizar-busca-das-estatísticas-de-chave-ou-de-pessoa.md): A busca de estatísticas por "key" será retornado o Payload completo no response de sucesso. A busca de estatísticas por "document" será retornado o Payload sem o objeto "KeyStatistics" no response de sucesso. - [Listar participantes do Pix](https://developers.celcoin.com.br/reference/consulta-participante-do-pix.md): Essa API possibilita que seja consultado o código do participante do Pix que será retornado em uma propriedade chamada **ispb**, geralmente usada em algumas requisições populando a propriedade bank. - [Iniciar pagamento Pix](https://developers.celcoin.com.br/reference/iniciar-pagamento-ou-transferencia-pix.md): Essa API permite que seja realizada a iniciação de um pagamento Pix a partir das regras populadas em seu payload. - [Verificar o status de um pagamento Pix](https://developers.celcoin.com.br/reference/verificar-o-status-de-um-pagamento-pix.md): Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação. A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta. No resultado, serão apresentado até 3 tipos de status diferentes: **PROCESSING:** Transação ainda em processamento; **CONFIRMED:** Transação confirmada com sucesso; **ERROR:** Transação com erro. Vide nó 'error' do payload de response para detalhes sobre o erro; As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento. - [Verificar o status de um pagamento Pix - Versão Enriquecida (V2)](https://developers.celcoin.com.br/reference/verificar-o-status-de-um-pagamento-pix-v2.md): Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação. A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta. No resultado, serão apresentado até 3 tipos de status diferentes: **PROCESSING:** Transação ainda em processamento; **CONFIRMED:** Transação confirmada com sucesso; **ERROR:** Transação com erro. Vide nó 'error' do payload de response para detalhes sobre o erro; As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento. - [Retornar informações de um QRCode pelo EMV](https://developers.celcoin.com.br/reference/retornar-informações-do-qr-code-a-partir-de-um-emv-full.md): Essa API possibilita a consulta do EMV (Pix Copia e Cola), de QR Codes estáticos e dinâmicos. Sem a necessidade de utilizar o endpoint de payload. - [Consulta uma devolução de pagamento Pix recebida](https://developers.celcoin.com.br/reference/consulta-o-status-de-uma-devolução-de-pagamento-pix.md): Endpoint destinado à consulta de detalhes posterior ao recebimento do webhook de devolução de pagamento Pix (pix-reversal-in ou REVERTED) - [Criar um Pix ITP](https://developers.celcoin.com.br/reference/criar-um-pix-itp.md) - [Criar Setup de um Pix ITP](https://developers.celcoin.com.br/reference/criar-setup-de-um-pix-itp.md) - [Editar Setup de um Pix ITP](https://developers.celcoin.com.br/reference/editar-setup-de-um-pix-itp.md) - [Listar operadoras](https://developers.celcoin.com.br/reference/retorna-a-lista-de-operadoras.md): Essa api retorna uma lista de todas as operadoras que a Celcoin consegue realizar uma recarga. Os tipos de recarga poderão ser informados como: **0** para **TODOS** **1** para **PIN** **2** para **ONLINE** A categoria de recarga poderá ser informada como: **0** para **TODOS** **1** para **TELEFONE** **2** para **JOGOS** **3** para **TV** **4** para **TRANSPORTE** **5** para **CONTEÚDO DIGITAL** Para lhe ensinar como utilizar essa api criamos o [artigo](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais#consultar-operadoras). - [Consultar valores operacionais para uma operadora ou provedor](https://developers.celcoin.com.br/reference/consulta-valores-operacionais.md): Essa API apresenta os valores disponibilizados por uma operadora ou provedor. Com objetivo de te ajudar a implementar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais#consultar-valores-operacionais) - [Reservar saldo para realizar recarga](https://developers.celcoin.com.br/reference/reserva-saldo-para-realizar-recarga.md): Essa API possibilita que seja realizada a reserva de um valor de sua conta Celcoin, para a execução de uma recarga. Para mais informações de como realizar essa implementação criamos o [artigo](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais#reserva-saldo-para-realizar-recarga) - [Confirmar a transação de uma recarga](https://developers.celcoin.com.br/reference/confirma-uma-recarga.md): Essa API possibilita que seja realizado de fato uma recarga. Para mais informações de como realizar a implementação dessa API, criamos o [artigo](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais#confirmar-a-transa%C3%A7%C3%A3o-de-uma-recarga) - [Consultar informações de uma recarga](https://developers.celcoin.com.br/reference/consultar-informações-de-uma-recarga.md): Essa API disponibiliza informações de uma recarga a partir de alguns campos. Criamos um [artigo](https://developers.celcoin.com.br/docs/sobre-recargas-nacionais#consultar-informa%C3%A7%C3%B5es-de-uma-recarga) que explica como usar essa API. - [Cancelar transação de recarga efetuada](https://developers.celcoin.com.br/reference/cancela-uma-transação-de-recarga-efetuada.md): Essa API cancela uma reserva que foi criada para realizar uma recarga. - [Buscar operadora a partir de um número de telefone](https://developers.celcoin.com.br/reference/buscar-operadora-a-partir-de-um-número-de-telefone.md): Essa API verifica qual operadora o número de telefone informado pertence. *A operadora OI foi vendida e está realizando a portabilidade de todos os seus números para as operadoras Claro, VIVO e TIM. Por este motivo, não conseguimos garantir que todos os números consultados da OI são de fato desse provedor. Neste caso, para concluir a ação de recarga, oriente o usuário do seu aplicativo, ou aplicação, a inserir o nome do provedor do número de telefone dele. - [Recargas - Obter comprovante de uma transação](https://developers.celcoin.com.br/reference/obter-um-comprovante-de-uma-transação-1.md): É possível realizar consulta de comprovantes até 150 dias após a efetivação da transação. - [Retornar lista de Parceiros](https://developers.celcoin.com.br/reference/retorna-lista-de-parceiros.md) - [Consultar pontos de atendimentos próximos](https://developers.celcoin.com.br/reference/consulta-pontos-de-atendimentos-próximos.md) - [Realizar depósito em um caixa 24h](https://developers.celcoin.com.br/reference/efetua-um-deposito-eletrônico.md): Para mais informações de como utilizar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/saques-e-dep%C3%B3sitos#como-funciona-um-dep%C3%B3sito-eletr%C3%B4nico-com-a-celcoin) - [Efetuar saque eletrônico com Qrcode](https://developers.celcoin.com.br/reference/efetua-um-saque-eletrônico.md): Para mais informações de como utilizar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/saques-e-dep%C3%B3sitos#como-funciona-um-saque-no-caixa-eletr%C3%B4nico-com-qrcode) - [Gerar token para saque no caixa 24h](https://developers.celcoin.com.br/reference/efetua-um-saque-eletrônico-com-token.md): Para mais informações de como utilizar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/saques-e-dep%C3%B3sitos#como-executar-um-saque-com-token) - [Cancela um token para saque no caixa 24h](https://developers.celcoin.com.br/reference/cancela-um-token-para-saque-no-caixa-24h.md): Para mais informações de como utilizar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/saques-e-dep%C3%B3sitos#como-executar-um-saque-com-token) - [Realizar TED](https://developers.celcoin.com.br/reference/efetuar-uma-transferência-bancária.md): Essa API possibilita que seja realizada uma transferência da sua conta proprietária. Celcoin para outra instituição financeira.Para saber como implementar essa API criamos o [artigo](https://developers.celcoin.com.br/docs/sobre-as-transfer%C3%AAncias).Mapeamos também os possíveis erros que essa API pode retornar nesse [artigo](https://developers.celcoin.com.br/docs/tabela-de-erros). Recomendamos que os campos sejam preenchidos conforme suas descriçōes. - [Verificar status de uma TED](https://developers.celcoin.com.br/reference/consulta-o-status-de-uma-transferência.md): Essa API possibilita que seja realizado a consulta de uma transferência a partir de seu id. - [Cadastro de Webhooks](https://developers.celcoin.com.br/reference/cadastro-de-webhooks.md) - [Cadastrar Webhook](https://developers.celcoin.com.br/reference/cadastrar-webhook-common.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Reenvio de webhooks pendentes](https://developers.celcoin.com.br/reference/reenvio-de-webhooks-pendentes-common.md) - [Consultar detalhes dos webhooks enviados.](https://developers.celcoin.com.br/reference/consultar-detalhes-dos-webhooks-enviados-common.md) - [Consultar quantidade de webhooks enviados.](https://developers.celcoin.com.br/reference/consultar-quantidade-de-webhooks-enviados-common.md) - [Excluir Webhook cadastrado.](https://developers.celcoin.com.br/reference/excluir-webhook-cadastrado-common.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Editar Webhook cadastrado.](https://developers.celcoin.com.br/reference/editar-webhook-cadastrado-common.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Consultar Webhooks cadastrados.](https://developers.celcoin.com.br/reference/consultar-webhooks-cadastrados-common.md): Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook - [Busca uma recorrência pelo ID](https://developers.celcoin.com.br/reference/busca-uma-recorrência-pelo-id.md) - [Cancelamento de Autorização](https://developers.celcoin.com.br/reference/cancelamento-de-autorização.md) - [Cancelamento de agendamento](https://developers.celcoin.com.br/reference/cancelamento-de-agendamento.md): Cancela um determinado agendamento. - [Aceita recorrência para jornadas 2 e 4](https://developers.celcoin.com.br/reference/aceita-recorrência-para-jornadas-2-e-4.md): Este endpoint servirá para aceitar uma recorrência para o tipo 2 ou para o tipo 4. - [Aceita recorrência jornada tipo 1](https://developers.celcoin.com.br/reference/aceita-recorrência-jornada-tipo-1.md): Este endpoint é destinado apenas para o consentimento da jornada do tipo 1 (push notification) - [Recusa uma recorrência jornada tipo 1](https://developers.celcoin.com.br/reference/recusa-uma-recorrência-jornada-tipo-1.md) - [Crie uma recorrência com a jornada 1](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-a-jornada-1.md) - [Crie uma recorrência com a jornada 2](https://developers.celcoin.com.br/reference/crie-uma-recorrência-com-a-jornada-2.md) - [Consulta o status de um Recebimento Pix](https://developers.celcoin.com.br/reference/consulta-o-status-de-um-recebimento-pix-indireto.md): Endpoint destinado à consulta do status de qualquer recebimento Pix, através do endtoEndId, transactionId ou transactionIdBrCode - [Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)](https://developers.celcoin.com.br/reference/consulta-o-status-de-um-recebimento-pix-versão-enriquecida-v2-indireto.md): Endpoint destinado à consulta do status de qualquer recebimento Pix, através do endtoEndId, transactionId ou transactionIdBrCode - [Gerar endToEndId para iniciar um pagamento](https://developers.celcoin.com.br/reference/gerar-endtoendid-para-iniciar-um-pagamento-indireto.md): Essa API permite gerar o EndToEndId para uso durante o fluxo de pagamento. - [Iniciar pagamento Pix](https://developers.celcoin.com.br/reference/iniciar-pagamento-pix-indireto.md): Essa API permite que seja realizada a iniciação de um pagamento Pix a partir das regras populadas em seu payload. - [Verificar o status de um pagamento Pix](https://developers.celcoin.com.br/reference/verificar-o-status-de-um-pagamento-pix-indireto.md): Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação. A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta. No resultado, serão apresentado até 3 tipos de status diferentes: **PROCESSING:** Transação ainda em processamento; **CONFIRMED:** Transação confirmada com sucesso; **ERROR:** Transação com erro. Vide nó 'error' do payload de response para detalhes sobre o erro; As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento. - [Verificar o status de um pagamento Pix - Versão Enriquecida (V2)](https://developers.celcoin.com.br/reference/verificar-o-status-de-um-pagamento-pix-versão-enriquecida-v2-indireto.md): Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação. A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta. No resultado, serão apresentado até 3 tipos de status diferentes: **PROCESSING:** Transação ainda em processamento; **CONFIRMED:** Transação confirmada com sucesso; **ERROR:** Transação com erro. Vide nó 'error' do payload de response para detalhes sobre o erro; As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento. - [Retornar informações do QR Code a partir de um EMV](https://developers.celcoin.com.br/reference/retornar-informações-do-qr-code-a-partir-de-um-emv-indireto.md): Essa API possibilita a consulta do EMV (Pix Copia e Cola), de QR Codes estáticos e dinâmicos. - [Criar devolução (estorno) de um Pix recebido](https://developers.celcoin.com.br/reference/criar-devolução-estorno-de-um-pix-recebido-copy.md): Essa API possibilita que seja realizada a devolução de um Pix recebido.Criamos um [artigo](https://developers.celcoin.com.br/docs/devolu%C3%A7%C3%A3o-de-recebimentos-pix-copy) explicando como implementar essa api. - [Criar devolução via endToEndId](https://developers.celcoin.com.br/reference/criar-devolução-via-e2e.md) - [Consulta o status de uma devolução Pix](https://developers.celcoin.com.br/reference/consulta-o-status-de-uma-devolução-pix-copy-1.md): Endpoint destinado à consulta de status posterior ao recebimento de webhook ou em caso de muita demora para o recebimento da confirmação. - [Consulta o status do recebimento de uma Devolução](https://developers.celcoin.com.br/reference/consulta-o-status-do-recebimento-de-uma-devolução-copy.md): Endpoint destinado à consulta de status posterior ao recebimento de webhook ou em caso de muita demora para o recebimento da confirmação. - [Cadastrar uma nova chave Pix](https://developers.celcoin.com.br/reference/cadastrar-uma-chave-pix-indireto.md): Essa API possibilita a criação de uma chave Pix - [Altera uma chave Pix](https://developers.celcoin.com.br/reference/alterar-uma-chave-pix-indireto.md): Essa API possibilita a realização do de uma chave Pix - [Retornar informações do DICT utilizando uma chave cadastrada no Pix](https://developers.celcoin.com.br/reference/retornar-informacoes-do-dict-utilizando-uma-chave-cadastrada-pix-indireto.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Verifica a existência de chaves no DICT](https://developers.celcoin.com.br/reference/verifica-a-existencia-de-chaves-no-dict-indireto.md): Esse _endpoint_ permite que você verifique se um conjunto de chaves (até 200 por requisição) existe no DICT e deve ser usado, exclusivamente, para sanitização de base e integração com a lista de contatos do usuário. - [Deleta uma chave Pix](https://developers.celcoin.com.br/reference/deletar-uma-chave-pix-indireto.md): Esse _endpoint_ permite que você verifique se um conjunto de chaves (até 200 por requisição) existe no DICT e deve ser usado, exclusivamente, para sanitização de base e integração com a lista de contatos do usuário. - [Realizar busca das estatísticas de chave ou de pessoa](https://developers.celcoin.com.br/reference/realizar-busca-das-estatísticas-de-chave-ou-de-pessoa-copy.md): A busca de estatísticas por "key" será retornado o Payload completo no response de sucesso. A busca de estatísticas por "document" será retornado o Payload sem o objeto "KeyStatistics" no response de sucesso. - [Listar todas as chaves pix de um cliente](https://developers.celcoin.com.br/reference/listar-todas-as-chaves-pix-de-um-cliente.md): Essa API permite realizar a listagem de todas as chaves pix de um determinado cliente - [Cadastra nova portabilidade ou reivindicação DICT](https://developers.celcoin.com.br/reference/cadastrar-nova-portabilidade-reivindicacao-dict-indireto.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Completa a solicitação de portabilidade/reivindicação de uma chave DICT](https://developers.celcoin.com.br/reference/completa-nova-portabilidade-ou-reivindicação-dict-indireto.md) - [Cancela uma Claim em processo de resolução ou confirmada por expiração](https://developers.celcoin.com.br/reference/cancela-solicitação-portabilidade-reivindicacao-chave-dict-indireto.md) - [Confirma uma Claim em processo de resolução](https://developers.celcoin.com.br/reference/confirma-claim-processo-resolucao-indireto.md) - [Consulta uma reivindicação existente](https://developers.celcoin.com.br/reference/consulta-claim-existente-indireto.md) - [Lista portabilidades ou reivindicações com paginação](https://developers.celcoin.com.br/reference/lista-reivindicacoes-indireto.md) - [Criar um relato de infração para uma transação](https://developers.celcoin.com.br/reference/criar-um-relato-de-infração-indireto.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Consultar um relato de Infração para uma transação](https://developers.celcoin.com.br/reference/consultar-relato-infração-indireto.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Cancelar um relato de infração para uma transação](https://developers.celcoin.com.br/reference/cancelar-um-relato-de-infração-indireto.md): Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude. - [Fechar um relato de infração de uma transação](https://developers.celcoin.com.br/reference/fechar-um-relato-de-infração-indireto.md) - [Lista infrações para participantes Indiretos](https://developers.celcoin.com.br/reference/lista-infrações-para-participantes-indiretos.md) - [Criar solicitação de devolução](https://developers.celcoin.com.br/reference/criar-solicitação-de-devolução-indireto.md) - [Consulta a solicitação de uma devolução](https://developers.celcoin.com.br/reference/consultar-solicitação-de-devolução-indireto.md) - [Cancelar solicitação de devolução](https://developers.celcoin.com.br/reference/cancelar-solicitação-devolução-indireto.md) - [Fechar solicitação de devolução](https://developers.celcoin.com.br/reference/fechar-solicitação-de-devolução-indireto.md) - [Lista solicitações de devolução](https://developers.celcoin.com.br/reference/lista-solicitações-de-devolução.md) - [Cancela marcação de fraude](https://developers.celcoin.com.br/reference/cancela-marcação-de-fraude.md) - [Cria marcação de fraude](https://developers.celcoin.com.br/reference/cria-marcação-de-fraude.md) - [Consulta detalhes da marcação de fraude](https://developers.celcoin.com.br/reference/consulta-detalhes-da-marcação-de-fraude.md) - [Criar um QR Code (location)](https://developers.celcoin.com.br/reference/criar-um-qr-code-location-copy.md): Essa API possibilita que seja realizado a criação de um QR Code para em seguida ser atrelado uma cobrança a ele, podendo ser com vencimento, ou imediata. - [Retorna os dados de um QR Code location](https://developers.celcoin.com.br/reference/retorna-os-dados-de-um-qr-code-location-copy.md) - [Deleta um QR code estático](https://developers.celcoin.com.br/reference/deleta-um-qr-code-estático-copy.md) - [Recupera uma imagem base64 representando um QR Code Location dinâmico](https://developers.celcoin.com.br/reference/recupera-uma-imagem-base64-representando-um-qr-code-location-dinâmico-copy.md) - [Criar cobrança com vencimento](https://developers.celcoin.com.br/reference/criar-cobrança-com-vencimento-copy.md): Essa API possibilita que seja realizado o vinculo de um QR Code a uma cobrança com vencimento, multa, juros, ou abatimentos (COBV). - [Atualizar dados de uma cobrança com vencimento](https://developers.celcoin.com.br/reference/atualizar-dados-de-uma-cobrança-com-vencimento-copy.md): Essa API possibilita que seja realizado a atualização do vencimento de um QR Code. - [Deletar uma cobrança com vencimento](https://developers.celcoin.com.br/reference/deletar-uma-cobrança-com-vencimento-copy.md): Usando o DELETE, o QR Code Location será automaticamente desvinculado da cobrança com vencimento. - [Buscar dados de uma cobrança com vencimento](https://developers.celcoin.com.br/reference/buscar-dados-de-uma-cobrança-com-vencimento-copy.md): Essa API possibilita a busca de dados de uma cobrança com vencimento (COBV) a partir do transctionId, transactionIdentification ou clientRequestId. - [Desvincular cobrança com vencimento de um QR Code location](https://developers.celcoin.com.br/reference/desvincular-cobrança-com-vencimento-de-um-qr-code-location-copy.md) - [Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)](https://developers.celcoin.com.br/reference/carrega-valida-e-analisa-a-carga-de-json-de-uma-cobrança-com-vencimento-cobv-copy.md): Essa API realiza a consulta de um QR Code, atrelado a uma cobrança com vencimento, a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Criar nova cobrança imediata](https://developers.celcoin.com.br/reference/criar-nova-cobrança-imediata-copy.md): Essa API possibilita que seja criada uma cobrança imediata, vinculada a um QR Code já criado (location). - [Atualizar dados de uma cobrança imediata](https://developers.celcoin.com.br/reference/atualizar-dados-de-uma-cobrança-imediata-copy.md): Essa API possibilita que seja atualizada uma cobrança imediata. - [Deletar uma cobrança imediata](https://developers.celcoin.com.br/reference/deletar-uma-cobrança-imediata-copy.md) - [Busca de dados de uma cobrança imediata](https://developers.celcoin.com.br/reference/busca-de-dados-de-uma-cobrança-imediata-copy.md): Essa API possibilita a busca de dados de uma cobrança imediata (COB) a partir do transctionId, transactionIdentification ou clientRequestId. - [Desvincular cobrança imediata de um BRCode Location](https://developers.celcoin.com.br/reference/desvincular-cobrança-imediata-de-um-brcode-location-copy.md): Essa API desvincula uma cobrança de um QR Code, desta forma é possível utilizá-lo para realizar outra cobrança. - [Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)](https://developers.celcoin.com.br/reference/carrega-valida-e-analisa-a-carga-de-json-de-uma-cobrança-imediata-cob-copy.md): Essa API realiza a consulta de um QR Code atrelado a uma cobrança imediata a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Criar um QR Code dinâmico](https://developers.celcoin.com.br/reference/criar-um-qr-code-dinâmico-copy.md): Essa API possibilita que seja criado um QR Code para cobranças dinâmicas imediatas e com valores pré-definidos. Com este endpoint, em uma chamada é realizado, automaticamente, o fluxo completo para criação de um QR Code: 1. endereçamento do QR Code (location); 2. criação da cobrança vinculada àquele QR Code (COB). - [Recupera uma imagem base64 representando um QR Code dinâmico](https://developers.celcoin.com.br/reference/recupera-uma-imagem-base64-representando-um-qr-code-dinâmico-copy.md) - [Atualizar QR Code dinâmico](https://developers.celcoin.com.br/reference/atualizar-qr-code-dinâmico-copy.md): Essa API possibilita que seja atualizado um QR Code para cobranças dinâmicas, ou seja que cobra de forma imediata e com valores pré-definidos. - [Deletar um QR Code dinâmico](https://developers.celcoin.com.br/reference/deletar-um-qr-code-dinâmico-copy.md) - [Carrega, valida e parseia o json do payload da URL](https://developers.celcoin.com.br/reference/carrega-valida-e-parseia-o-json-do-payload-da-url-copy.md): Essa API realiza a consulta de um QR Code atrelado a uma cobrança imediata a partir de uma URL que precisa estar no padrão urlenconded. Para testar o processo de deixar a urlenconded indicamos o uso do [site](https://www.urlencoder.org/) - [Criar um QR Code estático](https://developers.celcoin.com.br/reference/criar-um-qr-code-estático-copy.md): Essa API possibilita que seja criada um QR Code estático para cobranças Pix. - [Retornar dados de um QR Code estático.](https://developers.celcoin.com.br/reference/retornar-dados-de-um-qr-code-estático-copy.md) - [Recupera uma imagem base64 representando um QR Code estático](https://developers.celcoin.com.br/reference/recupera-uma-imagem-base64-representando-um-qr-code-estático-copy.md) - [Retornar dados do QR Code estático e os pagamentos recebidos](https://developers.celcoin.com.br/reference/retornar-dados-do-qr-code-estático-e-os-pagamentos-recebidos-copy.md) - [Transações fora do SPI - Reporte Bacen](https://developers.celcoin.com.br/reference/transações-fora-do-spi-reporte-bacen.md) - [MED 2.0](https://developers.celcoin.com.br/reference/med-20.md) - [Criar recuperação de valores](https://developers.celcoin.com.br/reference/criar-recuperação-de-valores.md) - [Consulta recuperação de valores](https://developers.celcoin.com.br/reference/consulta-recuperação-de-valores.md) - [Cancelar recuperação de valores](https://developers.celcoin.com.br/reference/cancelar-recuperação-de-valores.md) - [Solicitar devolução de recuperação de valores](https://developers.celcoin.com.br/reference/solicitar-devolução-de-recuperação-de-valores.md) - [Consulta grafo de recuperação de valores](https://developers.celcoin.com.br/reference/consultar-grafo-de-recuperação-de-valores.md) - [Atualiza recuperação de valores](https://developers.celcoin.com.br/reference/atualiza-recuperação-de-valores.md) - [ITP - Iniciador de pagamentos](https://developers.celcoin.com.br/reference/itp-iniciador-de-pagamentos.md): API para quem for iniciador ITP e que gerará o endToEnd para que possa ser utilizado na consulta - [Busca as transações de uma fatura.](https://developers.celcoin.com.br/reference/1186cec39b0cbe483a2aa78bc8980b81.md) - [Listar faturas da conta.](https://developers.celcoin.com.br/reference/ef66a3140d227dfbaf44692c4a96c219.md) - [Obtem detalhes de autorizações](https://developers.celcoin.com.br/reference/51011976cbae03e7a1a71d747cbba12a.md) - [Simula uma transação](https://developers.celcoin.com.br/reference/72ecce9f06bda6d3887187966bff78a4.md) - [Executa um chargeback](https://developers.celcoin.com.br/reference/a2e3a99c28775a68eca08d128f4a5a17.md) - [Busca dados de um cartão](https://developers.celcoin.com.br/reference/ebf2d0ba4cfd3139f4317acc3cb99892.md) - [Cria cartões de crédito/débito](https://developers.celcoin.com.br/reference/74263a95ceb5c2ee1655eabbc42f71e0.md) - [Lista cartões](https://developers.celcoin.com.br/reference/2fb18694a140ed94cc4d6109798a50cb.md) - [Atualiza dados de um Cartão](https://developers.celcoin.com.br/reference/dba8b62a17eb693182f099effd290226.md) - [Ativa um cartão](https://developers.celcoin.com.br/reference/cd2a46ad3a37d495eece564878c03a6a.md): Este endpoint serve para ativar um cartão físico após sua entrega ao portador. O cartão deve estar no status CREATED, ao executar este endpoint o status será alterado para NORMAL,permitindo transações no cartão. - [Bloqueia um cartão](https://developers.celcoin.com.br/reference/5d8aafa0910cfacf334ebd4f2c6b3627.md): Este endpoint deve ser utilizado para bloqueio do cartão quando solicitado pelo portador. Após executada o cartão passará para o status BLOKED, não sendo permitindo transacionar enquanto não retornar para o status NORMAL. - [Desbloqueia um cartão](https://developers.celcoin.com.br/reference/1b6d0c5c4ed4fab7761fe8deb979ee2f.md): Este endpoint deve ser utilizado para que um cartão com status BLOKED retorne para NORMAL. - [Cancela um cartão](https://developers.celcoin.com.br/reference/c432ada072f80e15d477f4335330ebf5.md): Este endpoint serve para cancelar um cartão. Após a execução, o status muda para CANCELLED e não pode ser revertido para NORMAL. Será possível gerar um novo cartão pelo endpoint de geração de cartão. - [Reemite um cartão](https://developers.celcoin.com.br/reference/6127f027ea23497fbfe58913b90ac164.md) - [Efetua a alteração do pin do cartão](https://developers.celcoin.com.br/reference/d3dabf62fceb4450a1f1b3e41c121d26.md) - [Busca a senha atual do cartão do cliente](https://developers.celcoin.com.br/reference/558bd49f128fefadbba81552ac30ed0b.md) - [Busca informações do cartão do cliente](https://developers.celcoin.com.br/reference/1e28376240132d6a15935535a5f3cc08.md) - [Reseta tentativas erradas de senha](https://developers.celcoin.com.br/reference/0527b4d0bd0025950ee975428460fff4.md) - [Reseta o contador de transações do aplicativo (ATC)](https://developers.celcoin.com.br/reference/43680f82bdeb483c021d7864e8d56299.md) - [Lista todos os clientes de uma conta específica.](https://developers.celcoin.com.br/reference/286c8dcd0570bfb72f12f2a2f08fbcec.md) - [Obtém um cliente de uma conta específica pelo Documento.](https://developers.celcoin.com.br/reference/b058221a30422c7366c1b6ca71c1091e.md) - [Obtém um cliente de uma conta específica pelo ID.](https://developers.celcoin.com.br/reference/03b8dc03bafe4e08ae24b87ac92fc82d.md) - [Atualiza os dados de um cliente (PF ou PJ)](https://developers.celcoin.com.br/reference/8124c843736991279246ab1bef141b0c.md) - [Busca dados de uma conta específica.](https://developers.celcoin.com.br/reference/1bd7b380132ba7bc27cbcd6050eb1277.md) - [Busca uma conta pelos parâmetros.](https://developers.celcoin.com.br/reference/25f3feedd3689848716ce768039aecd3.md) - [Cria uma nova conta](https://developers.celcoin.com.br/reference/06a69fbffaf07d9dcf16bf0d99a615be-1.md) - [Consulta os limites de uma conta específica](https://developers.celcoin.com.br/reference/d39c996d61c57217a767cb463b963a95.md) - [Atualiza limite de uma conta](https://developers.celcoin.com.br/reference/c72fa508ec35413d6404ff2af1fbc1bd.md) - [Passa conta informada para status cancelada.](https://developers.celcoin.com.br/reference/0e436897e68c0ed7b880fae43c6a94ae.md) - [Passa conta de status cancelada para normal.](https://developers.celcoin.com.br/reference/0ad8ba94b912f4c7d815db5f0f1128bf.md) - [Atualiza a data de vencimento da fatura](https://developers.celcoin.com.br/reference/3922b57e5840576a579d839859606503.md) - [Cria um novo endereço para uma conta específica](https://developers.celcoin.com.br/reference/972cea0493c5ea89395e25fc295908f4.md) - [Busca um único endereço de uma conta específica.](https://developers.celcoin.com.br/reference/eb576bc5e4bbc0ce7f3a440289582ec8.md) - [Atualiza os dados de um endereço](https://developers.celcoin.com.br/reference/805bb1a5ac2c7e435ed4d74030d18a93.md) - [Lista todos os endereços de uma conta específica.](https://developers.celcoin.com.br/reference/f6c54a8fc31b8f46489be32c4d67a9f5.md) - [Cria um novo telefone para uma conta específica](https://developers.celcoin.com.br/reference/47edc698b196fbfa4f434d4d314c0490.md) - [Busca de telefones cadastrado pela conta](https://developers.celcoin.com.br/reference/586f7fdc5d0d3a1f7655342202616809.md) - [Atualiza um telefone](https://developers.celcoin.com.br/reference/3e0908b70f9e30b847d8317b5d514c78.md) - [Atualiza um telefone](https://developers.celcoin.com.br/reference/e97858b35ae4c23ab6ca936e5272498e.md) - [Busca informações de embossing de um cartão](https://developers.celcoin.com.br/reference/d81f1a6565d8b2fd742eaca3e05ca71b.md) - [Simulação de rastreamento de um cartão](https://developers.celcoin.com.br/reference/c2aaa769f790e27b1e707b8996cfed6b.md) - [Atualiza endereço do embossing de um cartão](https://developers.celcoin.com.br/reference/8e56eb78821872b29fb69fafb7b63db4.md) - [Reenvia cartão para embossing](https://developers.celcoin.com.br/reference/83f302dfb147cea87791708f4e21fa66.md) - [Gerar token de autenticação](https://developers.celcoin.com.br/reference/aaas-gerar-token-de-autenticacao.md): Gerar token de autenticação JWT para consumir recursos da aplicação de Acquirer As A Service - [Cadastrar uma conta PF](https://developers.celcoin.com.br/reference/aaas-cadastrar-uma-conta-pf.md): Cadastra uma conta - [Cadastrar uma conta PJ](https://developers.celcoin.com.br/reference/aaas-cadastrar-uma-conta-pj.md): Cadastra uma conta PJ - [Solicitar relatório de recebíveis](https://developers.celcoin.com.br/reference/aaas-solicitar-relatório-de-recebíveis.md): Inicia o processo assíncrono de geração do relatório de recebíveis. - [Visualizar recebível de transação](https://developers.celcoin.com.br/reference/visualizar-recebivel.md): Permite visualizar o recebível de uma transação - [Visualizar recebível de contrato](https://developers.celcoin.com.br/reference/visualizar-recebivel-de-contrato.md): Permite visualizar o recebível de um contrato/venda - [Buscar estado de relatório solicitado](https://developers.celcoin.com.br/reference/aaas-buscar-estado-de-relatorio-solicitado.md): Retorna a situação de um relatório. - [Visualizar arquivo de relatório](https://developers.celcoin.com.br/reference/aaas-visualizar-arquivo-de-relatorio.md) - [Visualizar template de evento de webhook](https://developers.celcoin.com.br/reference/aaas-visualizar-template-de-evento-de-webhook.md): Permite visualizar modelo de webhook para um evento especificado. - [Visão Geral](https://developers.celcoin.com.br/reference/visao-geral-1.md) - [Glossário de Termos Técnicos](https://developers.celcoin.com.br/reference/glossario-de-termos-tecnicos-1.md) - [Autenticação](https://developers.celcoin.com.br/reference/autenticacao-1.md) - [Obter Token de Autenticação](https://developers.celcoin.com.br/reference/post_oauth2-token-4.md): Esse endpoint deve ser utilizado para obtenção de um _access-token_ para possibilitar a integração nas demais APIs da cel_credit. A API da **cel_credit** utiliza um protocolo de autorização chamado "OAuth 2.0". OAuth 2.0 é um protocolo de autorização de padrão aberto que permite a terceiros (aplicações) acessarem todo tipo de dados sem a obrigatoriedade de informar diretamente suas credenciais. Através de um **client ID** e **client secret** (chaves de autenticação do OAuth) é possível acessar os dados de uma determinada conta. Para mais informações acesse o site [http://oauth.net/2/](http://oauth.net/2/). - [Webhook](https://developers.celcoin.com.br/reference/webhook-credit.md) - [Variaveis Customizadas](https://developers.celcoin.com.br/reference/variaveis-customizadas.md) - [Fluxos de Cessão de Crédito](https://developers.celcoin.com.br/reference/cel-credit-fluxos-de-cessao.md) - [Tabela de erros](https://developers.celcoin.com.br/reference/cel-credit-tabelas-de-erros.md) - [Pessoa Fisica](https://developers.celcoin.com.br/reference/cel-credit-cadastro-de-tomador-pessoa-fisica.md) - [KYC (Know Your Customer)](https://developers.celcoin.com.br/reference/kyc-credito.md) - [Documentos](https://developers.celcoin.com.br/reference/cel-credit-tomador-envio-documento.md) - [Pessoa Juridica](https://developers.celcoin.com.br/reference/cel-credit-cadastro-tomador-pessoa-juridica.md) - [Documento](https://developers.celcoin.com.br/reference/documento-1.md) - [KYC (Know Your Costumer)](https://developers.celcoin.com.br/reference/kyc-know-your-costumer.md) - [Consultas, Escriturações e Repasses](https://developers.celcoin.com.br/reference/consultas-escrituracoes-e-repasses.md) - [Download do Comprovante de Desembolso](https://developers.celcoin.com.br/reference/cel-credit-solicitacoes-consultar-comprovante-desembolso.md) - [Download do Comprovante de Averbação](https://developers.celcoin.com.br/reference/cel-credit-solicitacoes-download-comprovante-averbacao.md) - [Qualificação ](https://developers.celcoin.com.br/reference/cel-credit-etapa-aprovacao-qualificacao.md) - [Simulações de Crédito](https://developers.celcoin.com.br/reference/cel-credit-simulacoes-de-credito.md) - [Status de Solicitações (Applications)](https://developers.celcoin.com.br/reference/cel-credit-solicitacoes-status.md) - [Cancelamento](https://developers.celcoin.com.br/reference/cel-credit-solicitacoes-cancelar.md) - [Retentativa de Pagamento](https://developers.celcoin.com.br/reference/cel-credit-retentativa-de-pagamento.md) - [Consignado Servidores do Exército](https://developers.celcoin.com.br/reference/consignado-servidores-do-exercito.md) - [Autenticação](https://developers.celcoin.com.br/reference/autenticacao-3.md) - [Consulta de Margem](https://developers.celcoin.com.br/reference/consulta-de-margem-4.md) - [Simulação de CCB](https://developers.celcoin.com.br/reference/simulacao-de-ccb.md) - [Cadastro de Tomador](https://developers.celcoin.com.br/reference/cadastro-de-tomador.md) - [Cadastro de Tomador & Solicitação](https://developers.celcoin.com.br/reference/cadastro-de-tomador-solicitacao.md) - [Compra com Troco](https://developers.celcoin.com.br/reference/compra-com-troco-1.md) - [Status de Operação](https://developers.celcoin.com.br/reference/status-de-operacao-2.md) - [Saque Aniversário FGTS](https://developers.celcoin.com.br/reference/saque-aniversario-fgts.md) - [Autenticação](https://developers.celcoin.com.br/reference/autenticacao-5.md) - [Consulta de Margem](https://developers.celcoin.com.br/reference/consulta-de-margem-6.md) - [Simulação de CCB](https://developers.celcoin.com.br/reference/simulacao-de-ccb-2.md) - [Cadastro de Tomador & Solicitação](https://developers.celcoin.com.br/reference/cadastro-de-tomador-solicitacao-2.md) - [Status de Operação](https://developers.celcoin.com.br/reference/status-de-operacao-4.md) - [Consulta Operações de Crédito](https://developers.celcoin.com.br/reference/cel-credit-consulta-operacoes-de-credito.md) - [Consultar os detalhes de uma Operação (CCB) emitida](https://developers.celcoin.com.br/reference/cel-credit-consultar-detalhes-operacao-ccb-emitida.md) - [Originação com Boleto de Entrada](https://developers.celcoin.com.br/reference/originacao-com-boleto-de-entrada.md) - [Originação com Multi Split de Pagamento](https://developers.celcoin.com.br/reference/originação-com-multi-split-de-pagamento.md) - [Originação com pagamento ao tomador](https://developers.celcoin.com.br/reference/originacao-com-pagamento-tomador.md) - [Originação com múltiplos assinantes](https://developers.celcoin.com.br/reference/originacao-com-multiplos-assinantes.md) - [Criação de CCB — Pagamento via QR Code PIX (EMV)](https://developers.celcoin.com.br/reference/copy-of-originação-com-múltiplos-assinantes.md) - [Criação de CCB — Pagamento de Boleto (BILLET_PAYMENT)](https://developers.celcoin.com.br/reference/copy-of-criação-de-ccb-pagamento-via-qr-code-pix-emv.md) - [Modalidades de Assinaturas](https://developers.celcoin.com.br/reference/modalidades-de-assinaturas.md) - [Assinatura via Cláusula Mandato (Timestamp)](https://developers.celcoin.com.br/reference/assinatura-via-clausula-mandato-timestamp.md) - [Assinatura via Envio de PDF (Assinatura Física/Externa)](https://developers.celcoin.com.br/reference/assinatura-via-envio-de-pdf-assinatura-físicaexterna.md) - [Consulta de Assinaturas da CCB](https://developers.celcoin.com.br/reference/consulta-de-assinaturas-da-ccb.md) - [Listar produtos licenciados](https://developers.celcoin.com.br/reference/cel-credit-listar-produtos-licenciados.md) - [Fluxo de produtos de Crédito](https://developers.celcoin.com.br/reference/cel-credit-fluxos-sequencia-implantacao.md) - [Listar Contas Beneficiárias](https://developers.celcoin.com.br/reference/cel-credit-listar-contas-beneficiarias.md) - [Eventos de garantia (Escrituração e repasse)](https://developers.celcoin.com.br/reference/eventos-de-garantia-escrituração-e-repasse.md) - [Listagem de Tickets](https://developers.celcoin.com.br/reference/listar-tickets.md): Este endpoint retorna uma lista com os últimos 200 tickets de suporte ao cliente abertos em nossa central de atendimento, com opções de filtragem por status e data de atualização - [Cadastrar uma Empresa](https://developers.celcoin.com.br/reference/cadastrar-uma-empresa.md) - [Consultar uma Empresa](https://developers.celcoin.com.br/reference/consultar-uma-empresa.md) - [Cadastrar um Certificado Digital para a Empresa](https://developers.celcoin.com.br/reference/cadastrar-um-certificado-digital.md) - [Emitir Nota Fiscal de Serviço](https://developers.celcoin.com.br/reference/emitir-nota-fiscal-de-servico.md) - [Consultar Nota Fiscal de Serviço](https://developers.celcoin.com.br/reference/consultar-nota-fiscal-de-servico.md) - [Cancelar emissão de Nota Fiscal de Serviço](https://developers.celcoin.com.br/reference/cancelar-emissao-nota-fiscal-servico.md) - [Obter token de autenticação](https://developers.celcoin.com.br/reference/post_oauth2-token-2.md): - **URL BASE PARA AUTENTICAÇÃO:** [https://sandbox.auth.flowfinance.com.br/oauth2/token](https://sandbox.auth.flowfinance.com.br/oauth2/token) Esse endpoint deve ser utilizado para obtenção de um _access-token_ para possibilitar a integração nas demais APIs da cel_credit. --- A API da **cel_credit** utiliza um protocolo de autorização chamado "OAuth 2.0". OAuth 2.0 é um protocolo de autorização de padrão aberto que permite a terceiros (aplicações) acessarem todo tipo de dados sem a obrigatoriedade de informar diretamente suas credenciais. Através de um **client ID** e **client secret** (chaves de autenticação do OAuth) é possível acessar os dados de uma determinada conta. Para mais informações acesse o site [http://oauth.net/2/](http://oauth.net/2/). ### Parâmetros da requisição Para realização da autenticação (basic auth) no OAuth 2.0 é necessário enviar um _username_ (client_id) e um _password_ (client_secret) para a requisição. - `grant_type`(string, obrigatório): "client_credentials" - `client_id`(string, obrigatório): ID do cliente para autenticação. - `client_secret`(string, obrigatório): Segredo do cliente para autenticação. - [Upload de Documentos da Pessoa](https://developers.celcoin.com.br/reference/post_escrow-api-v1-documents-upload.md): Esse endpoint deve ser utilizado para gerar um link que irá possibilitar o envio de documentos relacionados ao cadastro do tilular de uma conta que será criada posteriormente. Nós utilizamos o mecanismo de _"Pre-signed Uploads"_ da AWS: 1. Informar qual o nome do arquivo e sua extensão; 2. O serviço irá retornar uma "upload_url" e um "key"; 3. No upload_url deve ser feito o upload do base64 do arquivo; 4. O parâmetro "key" deve ser utilizado posteriormente no campo "" no cadastro da pessoa titular da conta; ### Parâmetros do Body - `file_name` (string, obrigatório): O nome completo do arquivo que será feito o upload com a extensão correta. Por exemplo "arquivo_identidade.pdf". ### Response Se processado com sucesso será retornado um status_code "200" e um JSON no seguinte formato: ``` json { "key": "", "upload_url": "", "download_url": "" } ``` - `key` (string/UUID): ID para identificação do arquivo que foi enviado; - `upload_url` (string): URL para fazer o envio do arquivo; - `download_url` (string): URL para fazer o download do arquivo; - [Criar uma pessoa do tipo "física"](https://developers.celcoin.com.br/reference/post_escrow-api-persons.md): Esse endpoint deve ser utilizado para cadastrar uma Pessoa do tipo física, usando um nº de CPF como identificador. ### Parâmetros do Body - `name` (string, obrigatório): O nome completo da pessoa. - `person_type` (string, obrigatório): O tipo da pessoa, informar o valor como "NATURAL" para o cadastro de uma pessoa física. Possíveis valores: NATURAL, LEGAL. - `taxpayer_id` (string, obrigatório): O número do documento CPF para identificação da Pessoa. - `documents` (object, obrigatório): Objeto contendo as 'keys' das URLs _'pre-signed'_ dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress). - `id_document` (object, obrigatório): Objeto para detalhar o documento de identificação que esta sendo enviado. - `issueDate` (string, obrigatório): Data de emissão do documento. - `issuer` (string, obrigatório): Orgão responsável pela emissão do documento. - `number` (string, obrigatório): Número do documento. - `type` (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE. - `birth_date` (string, obrigatório): Data de nascimento da Pessoa a ser cadastrada no formato "AAAA-MM-DD". - `mother_name` (string, obrigatóri): Nome da mãe. - `pep` (boolean, obrigatório): Campo para indica se a pessoa é politicamente exposta. - `email_address` (string, obrigatório): Endereço de e-mail para contato com a pessoa cadastrada. - `phone` (object, obrigatório): Objeto contendo os dados do telefone de contato. - `country_code` (string): Código do país. - `area_code` (string): Código de área. - `number` (string): Número do telefone. - `address` (object, obrigatório): Objeto contendo detalhes do endereço de cadastro. - `street_number` (string): Número do endereço informado. - `street_name` (string): Nome da rua. - `postal_code` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `state_code` (string): Código da UF para o estado do endereço. - `country_code` (string): Código do país. - `extra_info` (string): Complemento do endereço. - `fund_manager_id` (string/uuid v4): ID do gestor do Fundo, se aplicável. - `fund_securitizer_id` (string/uuid v4): ID da securitizadora do Fundo, se aplicável. - `fund_administrator_id` (string/uuid v4): ID do Admnistrador do Fundo, se aplicável. ### Resposta A resposta da requisição será um JSON representando o retorno obtido para os campos enviados. Em caso de sucesso será retornado um _status_code_ "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro. - `id` (string/uuid v4): ID gerado para o cadastro realizado da Pessoa física. ##### Exemplo de JSON: ``` json { "id": "" } ``` - [Listar as pessoas cadastradas](https://developers.celcoin.com.br/reference/get_escrow-api-persons.md): Esse endpoint é responsável por retornar uma lista paginada das pessoas cadastradas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. As informações sensíveis serão retornadas mascaradas por questão de segurança, porém, nesse endpoint é possível obter o ID da pessoa. #### Parâmetros da Requisição - `personId` (string/uuid v4): ID para filtro de uma Pessoa. - `taxpayerId` (string): Nº do CPF ou CNPJ da pessoa. - `search` (string): Campo para busca textual. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, taxpayerId. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - `hasNext` (boolean): Campo para indicar se tem uma próxima página. - `totalElements` (int): Quantidade total de registros retornados para a busca realizada. - `totalPages` (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string/uuid v4): ID do cadastro da pessoa. - `name` (string): O nome completo da pessoa. - `personType` (string): O tipo da pessoa. Possíveis valores: NATURAL, LEGAL. - `createdAt` (datetime): Data e hora do cadastro. - `businessType` (string): Tipo da empresa, se pessoa for do tipo jurídica. Possíveis valores: FUND, MANAGER, SECURITIZER, CONSULTANT, CUSTODIAN, ADMINISTRATOR, OTHERS. - `legalName` (string): Razão social, se pessoa for do tipo jurídica. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "personType": "NATURAL", "name": "", "createdAt": "", "businessType": "CUSTODIAN", "legalName": {} }, { "id": "", "personType": "LEGAL", "name": "", "createdAt": "", "businessType": "OTHERS", "legalName": {} } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Criar uma pessoa do tipo "jurídica"](https://developers.celcoin.com.br/reference/post_escrow-api-persons2.md): Esse endpoint deve ser utilizado para cadastrar uma Pessoa do tipo jurídica, usando um nº de CNPJ como identificador. ### Parâmetros do Body - `name` (string, obrigatório): A razão social associada ao CNPJ em cadastro. - `personType` (string, obrigatório): O tipo da pessoa, informar o valor "LEGAL" para cadastrar uma pessoa juridica. Possíveis valores: NATURAL, LEGAL. - `taxpayerId` (string, obrigatório): O número do CNPJ de registro da empresa na Receita Federal. - `documents` (object, obrigatório): Objeto contendo as 'keys' das URLs _'pre-signed'_ do documento de contrato social (documentIdentification) e comprovante de endereço (proofOfAddress). - `idDocument` (object, obrigatório): Objeto para detalhar o documento de identificação que esta sendo enviado. - `issueDate` (string, obrigatório): Data de emissão do documento. - `issuer` (string, obrigatório): Orgão responsável pela emissão do documento. - `number` (string, obrigatório): Número do documento. - `type` (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE. - `birthDate` (string, obrigatório): Data de abertura da empresa no formato "AAAA-MM-DD". - `emailAddress` (string, obrigatório): Endereço de e-mail para contato com a empresa cadastrada. - `phone` (object, obrigatório): Objeto contendo os dados do telefone de contato. - `countryCode` (string): Código do país. - `areaCode` (string): Código de área. - `number` (string): Número do telefone. - `address` (object, obrigatório): Objeto contendo detalhes do endereço de cadastro. - `streetNumber` (string): Número do endereço informado. - `streetName` (string): Nome da rua. - `postalCode` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `stateCode` (string): Código da UF para o estado do endereço. - `countryCode` (string): Código do país. - `extraInfo` (string): Complemento do endereço. - `fundManagerId` (string/uuid v4): ID do gestor do Fundo, se aplicável. - `fundSecuritizerId` (string/uuid v4): ID da securitizadora do Fundo, se aplicável. - `fundAdministratorId` (string/uuid v4): ID do Admnistrador do Fundo, se aplicável. - `representatives` (object): Objeto contendo os detalhes dos representantes da empresa. Deve ser enviado obrigatoriamente quando o tipo da Pessoa for jurídica (LEGAL). ##### Objeto "representatives" - `role` (string, obrigatório): O tipo do relacionamento. Valores aceitos: PARTNER, MANAGER, PROXY, OTHER, EMPLOYEE. - `taxpayerId` (string, obrigatório): O número do documento CPF para identificação da Pessoa. - `fullName` (string, obrigatório): Nome do representante. - `documents` (object): Objeto contendo as 'keys' das URLs _'pre-signed'_ dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress). - `idDocument` (object, obrigatório): Objeto para detalhar o documento de identificação que esta sendo enviado. - `issueDate` (string, obrigatório): Data de emissão do documento. - `issuer` (string, obrigatório): Orgão responsável pela emissão do documento. - `number` (string, obrigatório): Número do documento. - `type` (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE. - `birthDate` (string): Data de nascimento no formato "AAAA-MM-DD". - `motherName` (string, obrigatório): Nome da mãe. - `pep` (boolean, obrigatório): Campo para indica se a pessoa é politicamente exposta. - `signContract` (boolean, obrigatório): Indica se a pessoa é representante e pode assinar pela Empresa. - `emailAddress` (string, obrigatório): Endereço de e-mail para contato com a pessoa cadastrada. - `phone` (object): Objeto contendo os dados do telefone de contato. - `countryCode` (string): Código do país no formato "+99". - `areaCode` (string): Código de área. - `number` (string): Número do telefone. - `address` (object): Objeto contendo detalhes do endereço de cadastro. - `streetNumber` (string): Número do endereço informado. - `streetName` (string): Nome da rua. - `postalCode` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `stateCode` (string): Código da UF para o estado do endereço. - `countryCode` (string): Código do país. - `extraInfo` (string): Complemento do endereço. ### Resposta A resposta da requisição será um JSON representando o retorno obtido para os campos enviados. Em caso de sucesso será retornado um _status_code_ "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro. - `id` (string/uuid v4): ID gerado para o cadastro realizado da Pessoa Jurídica. ##### Exemplo de JSON: ``` json { "id": "" } ``` - [Atualizar cadastro da pessoa](https://developers.celcoin.com.br/reference/patch_escrow-api-persons-person-id.md): Esse endpoint permite uma atualização dos dados cadastrais de uma Pessoa. #### Parâmetros da URL - `person_id`: ID (uuid) da Pessoa cadastrada que terá os dados atualizados. #### Parâmetros da Requisição - `name` (string): O nome completo da pessoa. - `personType` (string): O tipo da pessoa. Possíveis valores: NATURAL, LEGAL. - `documents` (object): Objeto contendo as 'keys' das URLs _'pre-signed'_ dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress). - `idDocument` (object): Objeto para detalhar o documento de identificação que esta sendo enviado. - `issueDate` (string, obrigatório): Data de emissão do documento. - `issuer` (string, obrigatório): Orgão responsável pela emissão do documento. - `number` (string, obrigatório): Número do documento. - `type` (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE. - `birthDate` (string): Data de nascimento no formato "AAAA-MM-DD". - `motherName` (string): Nome da mãe. - `pep` (boolean): Campo para indica se a pessoa é politicamente exposta. - `emailAddress` (string): Endereço de e-mail para contato com a pessoa cadastrada. - `phone` (object): Objeto contendo os dados do telefone de contato. - `countryCode` (string): Código do país. - `areaCode` (string): Código de área. - `number` (string): Número do telefone. - `address` (object): Objeto contendo detalhes do endereço de cadastro. - `streetNumber` (string): Número do endereço informado. - `streetName` (string): Nome da rua. - `postalCode` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `stateCode` (string): Código da UF para o estado do endereço. - `countryCode` (string): Código do país. - `extraInfo` (string): Complemento do endereço. - `fundManagerId` (string/uuid v4): ID do gestor do Fundo, se aplicável. - `fundSecuritizerId` (string/uuid v4): ID da securitizadora do Fundo, se aplicável. - `fundAdministratorId` (string/uuid v4): ID do Admnistrador do Fundo, se aplicável. - `representatives` (object): Objeto contendo os detalhes dos representantes. Deve ser enviado quando o tipo da Pessoa for jurídica (LEGAL). ##### Objeto "representatives" - `role` (string): O tipo do relacionamento. Valores aceitos: PARTNER, MANAGER, PROXY, OTHER, EMPLOYEE. - `taxpayerId` (string): O número do documento CPF para identificação da Pessoa. - `fullName` (string): Nome do representante. - `documents` (object): Objeto contendo as 'keys' das URLs _'pre-signed'_ dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress). - `idDocument` (object): Objeto para detalhar o documento de identificação que esta sendo enviado. - `issueDate` (string): Data de emissão do documento. - `issuer` (string): Orgão responsável pela emissão do documento. - `number` (string): Número do documento. - `type` (string): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE. - `birthDate` (string): Data de nascimento no formato "AAAA-MM-DD". - `motherName` (string): Nome da mãe. - `pep` (boolean): Campo para indica se a pessoa é politicamente exposta. - `signContract` (boolean): Indica se a pessoa é representante e pode assinar pela Empresa. - `emailAddress` (string): Endereço de e-mail para contato com a pessoa cadastrada. - `phone` (object): Objeto contendo os dados do telefone de contato. - `countryCode` (string): Código do país no formato "+99". - `areaCode` (string): Código de área. - `number` (string): Número do telefone. - `address` (object): Objeto contendo detalhes do endereço de cadastro. - `streetNumber` (string): Número do endereço informado. - `streetName` (string): Nome da rua. - `postalCode` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `stateCode` (string): Código da UF para o estado do endereço. - `countryCode` (string): Código do país. - `extraInfo` (string): Complemento do endereço. #### Resposta A resposta da requisição será um JSON representando o retorno obtido para os campos enviados. Em caso de sucesso será retornado um _status_code_ "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro. - [Introdução](https://developers.celcoin.com.br/reference/credit-escrow-introducao.md) - [Criar uma nova conta](https://developers.celcoin.com.br/reference/post_escrow-api-v1-accounts.md): Esse endpoint permite ao operador enviar uma solicitação para a abertura de uma nova conta escrow. Após o processamento da requisição do operador, a nova conta ficará no status de "aguardando analise" (WAITING_ANALYSIS), até sua posterior aprovação e liberação para uso. #### Parâmetros da Requisição - `personId` (string/uuid v4, obrigatório): ID de cadastro da Pessoa. - `parties` (object, obrigatório): Objeto contendo os dados das partes envolvidas. - `tenantType` (string): Tipo da estrutura onde a conta será alocada. Possíveis valores: 'default', 'prime'. - `accountType` (string): Tipo da conta. Possíveis valores: 'ESCROW', 'PAYMENT'. ##### Objeto "parties" - `person` (object, obrigatório): Objeto contendo os dados da Pessoa. - `person -> id` (string, obrigatório): ID de cadastro da Pessoa. - `person -> businessType` (string, obrigatório): Tipo da pessoa participante na conta. Possíveis valores aceitos: 'FUND', 'MANAGER', 'SECURITIZER', 'CONSULTANT', 'CUSTODIAN', 'ADMINISTRATOR', 'OTHERS'. - `signContract` (boolean, obrigatório): Flag para indicar se terá assinatura de contrato. - `permissions` (array, obrigatório): Lista com as permissões a serem aplicadas na conta. ##### Objeto "permissions" O objeto "permissions" pode receber uma lista com as permissões a serem liberadas na conta. Possíveis valores: - MANAGE_USER - VIEW_ACCOUNT - CREATE_POSTING - REVIEW_POSTING - POSTING_VIEW - CREATE_WALLET - VIEW_WALLET - UPDATE_WALLET - ARCHIVE_WALLET - CREATE_CHARGE - CANCEL_CHARGE - VIEW_CHARGE - UPDATE_CHARGE - CREATE_APPROVED - CREATE_BALANCE_RETENTION - REMOVE_BALANCE_RETENTION - VIEW_BALANCE_RETENTION - CREATE_ACCOUNT - CREATE_BENEFICIARY - CREATE_DEPOSIT_RETENTION - VIEW_DEPOSIT_RETENTION - DELETE_DEPOSIT_RETENTION - UPDATE_DEPOSIT_RETENTION #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID para identificação da solicitação cadastrada. ##### Exemplo de JSON: ``` json { "id": "" } ``` - [Listas todas as contas cadastradas](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts.md): Esse endpoint é responsável por retornar uma lista paginada de contas escrow cadastradas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. #### Parâmetros da Requisição - `status` (string): Status da conta. Possíveis valores aceitos: CREATING, ERROR_CREATING, PENDING_ACTIVATION, ACTIVE, BLOCKING, ERROR_BLOCKING, UNBLOCKING, ERROR_UNBLOCKING, BLOCKED, CANCELING, ERROR_CANCELING, CANCELED. - `personId` (string/uuid v4): ID para filtro de contas de uma Pessoa. - `taxpayerId` (string): Nº do CPF ou CNPJ do pagador. - `account` (string): ID da conta para consulta das solicitações - `creatorName` (string): Nome do criador da conta. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status, account. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - `hasNext` (boolean): Campo para indicar se tem uma próxima página. - `totalElements` (int): Quantidade total de registros retornados para a busca realizada. - `totalPages` (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string): ID para identificação da conta escrow. - `status` (string): Status do conta. Possíveis valores: CREATING, ERROR_CREATING, PENDING_ACTIVATION, ACTIVE, BLOCKING, ERROR_BLOCKING, UNBLOCKING, ERROR_UNBLOCKING, BLOCKED, CANCELING, ERROR_CANCELING, CANCELED. - `person` (object): Objeto contendo os dados da Pessoa. - `person -> id` (string): ID de cadastro da Pessoa. - `person -> name` (string): Nome da Pessoa - `person -> taxpayerId` (string): Número do CPF da Pessoa - `person -> personType` (string): Tipo da Pessoa. Possíveis valores: LEGAL, PERSON - `creator` (object): Objeto contendo os dados de quem fez o cadastro da conta. - `creator -> id` (string): ID de cadastro. - `creator -> fullname` (string): Nome completo. - `creator -> taxpayerId` (string): Número do CPF. - `createdAt` (datetime): Data da criação da conta. - `account` (string): Número da conta. - `error` (string): Retorno em caso de algum erro na geração da conta. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "person": { "id": "", "name": "", "taxpayerId": "", "personType": "LEGAL" }, "creator": { "id": "", "fullName": "", "taxpayerId": "" }, "createdAt": "", "status": "ERROR_CANCELING", "account": "", "error": "" } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Consultar os detalhes de uma conta escrow](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id.md): Esse endpoint é responsável por retornar os dados de uma conta escrow, retornando todos os dados que foram recepcionados do envio, como o número da conta, status atualizado, usuário responsável pelo cadastro, dados da Pessoa titular da conta. Tenha acesso aos detalhes de todas as transações, lançamentos, tarifas, lançamentos futuros e solicitações de transações #### Parâmetros da URL - `account_id` (string): ID de cadastro para identificação da conta a ser consultada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID para identificação da conta escrow. - `status` (string): Status do conta. Possíveis valores: CREATING, ERROR_CREATING, PENDING_ACTIVATION, ACTIVE, BLOCKING, ERROR_BLOCKING, UNBLOCKING, ERROR_UNBLOCKING, BLOCKED, CANCELING, ERROR_CANCELING, CANCELED, WAITING_ANALYSIS, IN_ANALYSIS, WAITING_UPDATES. - `account` (string): Número da conta. - `branch` (string): Número da agência. - `error` (string): Retorno em caso de algum erro na geração da conta. - `fees` (object): Objeto contendo os dados das tarifas associadas a conta. - `person` (object): Objeto contendo os dados da Pessoa. - `destinations` (object): Objeto contendo os dados das contas bancárias cadastrads para transações. ##### Objeto 'Person' - `person -> id` (string): ID de cadastro da Pessoa. - `person -> name` (string): Nome da Pessoa - `person -> taxpayerId` (string): Número do CPF da Pessoa - `person -> emailAddress` (string): E-mail de contato. - `person -> birthDate` (string): Data de nascimento, caso o titular seja uma pessoa física. - `person -> phone` (object): Objeto contendo os dados do telefone para contato. - `person -> personType` (string): Tipo da Pessoa. Possíveis valores: LEGAL, NATURAL. - `person -> address` (object): Objeto contendo detalhes do endereço de cadastro. - `person -> representatives` (object): Objeto contendo os dados dos sócios, caso o titular da conta seja uma pessoa jurídica. - `person -> creator` (object): Objeto contendo os dados de quem fez o cadastro da conta. - `person -> documents` (object): Objeto contendo os dados dos documentos anexados na conta. - `corporateName` (string): Razão social da empresa, caso o titular da conta seja uma pessoa jurídica. - `foundationDate` (datetime): Data de abertura da empresa, caso o titular da conta seja uma pessoa jurídica. - `cnae` (string): Código do CNAE referente a atividade principal da empresa, caso o titular da conta seja uma pessoa jurídica. ##### Objeto 'address' - `streetNumber` (string): Número do endereço informado. - `streetName` (string): Nome da rua. - `postalCode` (string): Código de CEP para o endereço. - `district` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `stateCode` (string): Código da UF para o estado do endereço. - `countryCode` (string): Código do país. - `extraInfo` (string): Complemento. ##### Objeto 'phone' - `phone -> countryCode` (string): Código DDI do país. - `phone -> areaCode` (string): Código DDD da área. - `phone -> number` (string): Número de telefone. ##### Objeto 'documents' - `documents -> incorporationCertificateUrl` (string): Endereço web (URL) do contrato social de constituição da empresa. - `documents -> proofOfAddressUrl` (string): Endereço web (URL) do documento de comprovante de residência. - `documents -> bylawsUrl` (string): Endereço web (URL) do estatuto societário da empresa. - `documents -> powerOfAttorneyUrl` (string): Endereço web (URL) de uma procuração. - `documents -> incomeStatementUrl` (string): Endereço web (URL) do comprovante de renda. - `documents -> lastContractAmendmentUrl` (string): Endereço web (URL) da última alteração contratual. - `documents -> identificationUrl` (string): Endereço web (URL) do comprovante de identidade. ##### Objeto 'creator' - `creator -> id` (string): ID de cadastro. - `creator -> fullname` (string): Nome completo. - `creator -> taxpayerId` (string): Número do CPF. - `createdAt` (datetime): Data da criação da conta. ##### Objeto 'representatives' (Se titular for do tipo uma pessoa jurídica, 'LEGAL') - `role` (string): Função ou cargo do representante. Valores aceitos: MANAGER - `taxpayerId` (string): Número do CPF do representante. - `fullName` (string): Nome completo. - `motherName` (string): Nome da mãe, conforme registro e documento de identidade. - `emailAddress` (string): E-mail principal de contato. - `birthDate` (datetime): Data de nascimento. - `signContract` (boolean): Flag para indicar se o representante possui poderes para assinar pela empresa. - `representatives -> phone` (object): Objeto contendo os dados do telefone para contato do representante. - `representatives -> address` (object): Objeto contendo detalhes do endereço de cadastro do representante. - `representatives -> documents` (object): Objeto contendo os dados dos documentos comprobatórios do sócio. ##### Objeto 'fees' - `mode` (string): Forma de cobrança das tarifas. Possíveis valores: DIRECT_DEBIT. - `defaultPaymentType` (string): Forma de pagamento para cobrança das tarifas. Possíveis valores: PIX, TED. - `maintenance` (object): Objeto com os dados tarifa de manutenção da conta. - `maintenance -> day` (integer): Dia do mês que será feita a cobrança. - `maintenance -> amount` (float): Valor a ser cobrado pela tarifa. - `deposit -> amount` (float): Valor da tarifa para depósitos. - `withdrawal -> amount` (float): Valor da tarifa para saques. - `tedTransfer -> amount` (float): Valor da tarifa para transferências por TED. - `tedDeposit -> amount` (float): Valor da tarifa para depósitos por TED. ##### Objeto 'destinations' - `id` (string): ID de cadastro da conta de destino. - `taxpayerId` (string): Número do CPF ou CNPJ do titular da conta. - `name` (string): Nome completo do titular da conta. - `bank` (string): Código de identificação do banco. - `branch` (string): Número da agência. - `account` (string): Número da conta bancária. - `type` (string): Tipo da conta a ser cadastrada. ##### Exemplo de JSON: ``` json { "id": "", "status": "ACTIVE", "personId": "", "documents": { "openingAgreement": "" }, "person": { "taxpayerId": "", "name": "", "emailAddress": "", "phone": { "countryCode": "+860", "areaCode": "", "number": "" }, "address": { "streetName": "", "streetNumber": "", "postalCode": "20547430", "district": "", "city": "", "stateCode": "", "countryCode": "", "extraInfo": "" }, "personType": "LEGAL", "documents": { "incorporationCertificateUrl": "", "proofOfAddressUrl": "", "bylawsUrl": "", "powerOfAttorneyUrl": "", "incomeStatementUrl": "", "lastContractAmendmentUrl": "", "identificationUrl": "" }, "representatives": [ { "role": "MANAGER", "taxpayerId": "", "fullName": "", "motherName": "", "emailAddress": "", "birthDate": "", "phone": { "countryCode": "+8", "areaCode": "", "number": "" }, "address": { "streetName": "", "streetNumber": "", "postalCode": "44019726", "district": "", "city": "", "stateCode": "", "countryCode": "", "extraInfo": "" }, "documents": { "identificationUrl": "", "proofOfAddressUrl": "" }, "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "motherName": "", "emailAddress": "", "birthDate": "", "phone": { "countryCode": "+1", "areaCode": "", "number": "" }, "address": { "streetName": "", "streetNumber": "", "postalCode": "73044278", "district": "", "city": "", "stateCode": "", "countryCode": "", "extraInfo": "" }, "documents": { "identificationUrl": "", "proofOfAddressUrl": "" }, "signContract": "" } }, { "role": "MANAGING_PARTNER", "taxpayerId": "", "fullName": "", "motherName": "", "emailAddress": "", "birthDate": "", "phone": { "countryCode": "+2", "areaCode": "", "number": "" }, "address": { "streetName": "", "streetNumber": "", "postalCode": "74113438", "district": "", "city": "", "stateCode": "", "countryCode": "", "extraInfo": "" }, "documents": { "identificationUrl": "", "proofOfAddressUrl": "" }, "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "motherName": "", "emailAddress": "", "birthDate": "", "phone": { "countryCode": "+1", "areaCode": "", "number": "" }, "address": { "streetName": "", "streetNumber": "", "postalCode": "49674137", "district": "", "city": "", "stateCode": "", "countryCode": "", "extraInfo": "" }, "documents": { "identificationUrl": "", "proofOfAddressUrl": "" }, "signContract": "" } } ], "corporateName": "", "foundationDate": "", "birthDate": "", "cnae": "" }, "parties": [ { "id": "", "person": { "id": "", "businessType": "CONSULTANT", "name": "", "taxpayerId": "", "representatives": [ { "taxpayerId": "", "fullName": "", "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "signContract": "" } }, { "taxpayerId": "", "fullName": "", "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "signContract": "" } } ], "corporateName": "" }, "signContract": "", "permissions": [ "CREATE_CHARGE", "VIEW_ACCOUNT" ] }, { "id": "", "person": { "id": "", "businessType": "CONSULTANT", "name": "", "taxpayerId": "", "representatives": [ { "taxpayerId": "", "fullName": "", "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "signContract": "" } }, { "taxpayerId": "", "fullName": "", "signContract": "", "representative": { "taxpayerId": "", "fullName": "", "signContract": "" } } ], "corporateName": "" }, "signContract": "", "permissions": [ "POSTING_CREATE", "CANCEL_CHARGE" ] } ], "destinations": [ { "id": "", "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" }, { "id": "", "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" } ], "branch": "", "account": "", "error": "", "fees": { "mode": "DIRECT_DEBIT", "defaultPaymentType": "PIX", "maintenance": { "day": "", "amount": "" }, "deposit": { "amount": "" }, "withdrawal": { "amount": "" }, "tedTransfer": { "amount": "" }, "tedDeposit": { "amount": "" } } } ``` - [Consultar o extrato da conta](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-statement.md): Esse endpoint é responsável por retornar o extrato da conta escrow, uma lista paginada de transações e solicitações realizadas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. #### Parâmetros da URL - `account_id` (string): ID de cadastro para identificação da conta a ser consultada. #### Parâmetros da Requisição - `dateFrom` (datetime, obrigatório): Data de ínicio para filtro. - `dateTo` (datetime, obrigatório): Data de fim para filtro. - `balanceType` (string): Tipo da transação. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createDate, clientCode. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - hasNext (boolean): Campo para indicar se tem uma próxima página. - totalElements (int): Quantidade total de registros retornados para a busca realizada. - totalPages (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string): ID para identificação da transação. - `clientCode` (string): Identificador único gerado pelo cliente. - `description` (string): Descrição do comprovante da transação. - `createDate` (datetime): Data de registro da transação. - `lastUpdateDate` (datetime): Data da última atualização efetuada. - `amount` (float): Valor da transação. - `status` (string): Status do processamento. - `balanceType` (string): Tipo . - `moventType` (string): Tipo da movimentação. - `balance` (float): Saldo final. - `additionalInformation -> nameCredit` (string): . - `additionalInformation -> nameDebit` (string): . ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "clientCode": "", "description": "", "createDate": "", "lastUpdateDate": "", "amount": "", "status": "", "balanceType": "", "movementType": "", "balance": "", "additionalInformation": { "nameCredit": "", "nameDebit": "" } }, { "id": "", "clientCode": "", "description": "", "createDate": "", "lastUpdateDate": "", "amount": "", "status": "", "balanceType": "", "movementType": "", "balance": "", "additionalInformation": { "nameCredit": "", "nameDebit": "" } } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Consultar o status/detalhamento de uma transação](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-statement-client-code-status.md): Esse endpoint é responsável por retornar o status e detalhamento de uma transação do extrato. #### Parâmetros da Requisição - `account_id` (string): ID de cadastro para identificação da conta a ser consultada. - `client_code` (string): Identificador único gerado pelo cliente. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID da transação. - `amount` (float): Valor da transação - `clientCode` (string): Identificador único gerado pelo cliente. - `debitParty` (object): Objeto contendo os dados da conta de origem (quem irá pagar). - `creditParty` (object): Objeto contendo os dados da conta de destino (quem irá receber). - `transactionIdentification` (string): Protocolo de identificação da operação. - `endToEndId` (string): Identificador ponta-a-ponta associado ao pagamento. Se initiationType igual a MANUAL, esse campo não deve ser informado pois o mesmo sera gerado pela plataforma Celcoin. - `initiationType` (string): Tipo de iniciação do pagamento. Possíveis valores: - 'MANUAL': Pagamento via dados transacionais da conta (creditParty.key, endToEndId, e transactionIdentification, não devem ser enviados). - 'DICT': Pagamento PIX via chave. (Campos obrigatórios : creditParty.key, e endToEndId.transactionIdentification não deve ser informado). - 'STATIC_QRCODE': Pagamento PIX via BRCode estatico. (Campos obrigatórios : creditParty.key, endToEndId, e transactionIdentification). - 'DYNAMIC_QRCODE': Pagamento PIX via BRCode dinamico. (Campos obrigatórios : creditParty.key, endToEndId, e transactionIdentification). - `paymentType` (string): Tipo de pagamento. Possíveis valores: IMMEDIATE: Usado para pagamentos imediatos; FRAUD: Usado para pagamento por suspeita de fraude; SCHEDULED: Usado apenas para pagamentos agendados. - `urgency` (string): Determina a urgência do pagamento. Possíveis valores: - 'HIGH' - Usado para pagamentos imediatos. - 'NORMAL' - Usado para pagamentos agendados. - `transactionType` (string): Tipo da transação de PIX. Possíveis valores: TRANSFER. - `remittanceInformation`(string): Informação da remessa. Texto a ser informado na transação. ##### Objeto 'debitParty' - `bank` (string): Código do banco. - `account` (string): Número da conta - `branch` (string): Número da agência. - `taxId` (string): Número do documento (CPF ou CNPJ) da conta de origem. - `name` (string): Nome do titular da conta. - `accountType` (string): Tipo da conta. Possíveis valores: **CC** - Conta Corrente; **CI** - Conta Investimento; **PG** - Conta de Pagamento; **PP** - Conta Poupança. - `key` (string): Chave PIX ##### Objeto 'creditParty' - `bank` (string): Código do banco. - `account` (string): Número da conta - `branch` (string): Número da agência. - `taxId` (string): Número do documento (CPF ou CNPJ) da conta de destino. - `name` (string): Nome do titular da conta. - `accountType` (string): Tipo da conta. Possíveis valores: **CC** - Conta Corrente; **CI** - Conta Investimento; **PG** - Conta de Pagamento; **PP** - Conta Poupança. - `key` (string): Chave PIX ##### Exemplo de JSON: ``` json { "id": "", "amount": "", "clientCode": "", "debitParty": { "account": "", "branch": "", "taxId": "", "name": "", "accountType": "" }, "creditParty": { "bank": "", "account": "", "branch": "", "taxId": "", "name": "", "accountType": "", "key": "" }, "transactionIdentification": "", "endToEndId": "", "initiationType": "", "paymentType": "", "urgency": "", "transactionType": "", "remittanceInformation": "" } ``` - [Consultar o saldo da conta](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-balance.md): Esse endpoint é responsável por retornar o saldo da conta escrow. #### Parâmetros da URL - `account_id` (string): ID de cadastro para identificação da conta a ser consultada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `amount`(float): Valor liberado na conta. - `blocked_amount`(float): Valor bloqueado na conta. ##### Exemplo de JSON: ``` json { "amount": float, "blocked_amount": float } ``` - [Cadastrar uma retenção](https://developers.celcoin.com.br/reference/post_escrow-api-v1-accounts-account-id-deposit-retention.md): Esse endpoint permite o cadastro de uma regra de retenção para fazer um bloqueio automático de valores em uma conta. #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta a ser configurada. #### Parâmetros da Requisição - `name` (string, obrigatório): O nome para identificação da regra. - `startDate` (string, obrigatório): Data de inicio para aplicação da regra de retenção na conta. Após essa data a retenção estará "ATIVA" e irá ser aplicada até a data final. - `endDate` (string, obrigatório): Data final para encerramento da regra de retenção. Após essa data a retenção não será mais aplicada e todo valor transacionado será enviado para a conta destinatária indicada via PIX (gerando tarifa normalmente). - `amountPercentage` (float, obrigatório): Valor percentual a ser aplicado na retenção dos valores transacionados. - `origins` (array, obrigatório): Lista de CPFs ou CNPJs para aplicar a regra de retenção. Se informada uma lista a regra de retenção só será aplicada se for transacionada por esses números de documentos. - `shouldRetainSlc` (boolean, obrigatório): Flag para indicar se a retenção também será aplicada em depósitos do tipo SLC, com as mesmas regras de PIX e TED. - `accountDestination` (string/uuid, obrigatório): ID de identificação da conta beneficiária, ou seja, conta que irá receber os valores retidos. - `description` (string): Descrição para detalhamento da regra e condições da retenção. - `maxAmount` (float): Valor máximo a ser retido. Deve ser estipulado um valor máximo que será retido na retenção cadastrada. Ao atingir esse valor a retenção automaticamente será bloqueada até a data final configurada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um ID da retenção configurada: - `id` (string/uuid): ID da retenção cadastrada. - [Listar todas as retenções cadastradas](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-deposit-retention.md): Esse endpoint é responsável por retornar uma lista paginada de retenções cadastradas para uma determinada conta. #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta a ser configurada. #### Parâmetros da Requisição - `search` (string): Busca textual no nome da retenção. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - `hasNext` (boolean): Campo para indicar se tem uma próxima página. - `totalElements` (int): Quantidade total de registros retornados para a busca realizada. - `totalPages` (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string/uuid): ID de cadastro da retenção. - `name` (string): O nome para identificação da regra. - `status` (string): Status atual da regra de retenção. Possíveis valores: CREATED, ACTIVE, REMOVED, ERROR - `startDate` (string): Data de inicio para aplicação da regra de retenção na conta. Após essa data a retenção estará "ATIVA" e irá ser aplicada até a data final. - `endDate` (string): Data final para encerramento da regra de retenção. Após essa data a retenção não será mais aplicada e todo valor transacionado será enviado para a conta destinatária indicada via PIX (gerando tarifa normalmente). - `amountPercentage` (float): Valor percentual a ser aplicado na retenção dos valores transacionados. - `origins` (array): Lista de CPFs ou CNPJs para aplicar a regra de retenção. Se informada uma lista a regra de retenção só será aplicada se for transacionada por esses números de documentos. - `shouldRetainSlc` (boolean): Flag para indicar se a retenção também será aplicada em depósitos do tipo SLC, com as mesmas regras de PIX e TED. - `destination` (object): Objeto contendo os dados da conta beneficiária, ou seja, conta que irá receber os valores retidos. - `createdAt` (datetime): Data de cadastro da regra. - `description` (string): Descrição para detalhamento da regra e condições da retenção. - `maxAmount` (float): Valor máximo a ser retido. Deve ser estipulado um valor máximo que será retido na retenção cadastrada. Ao atingir esse valor a retenção automaticamente será bloqueada até a data final configurada. - `balanceRetention` (object): Objeto contendo o saldo das retenções realizadas. ##### Objeto 'destination' - `id` (string/uuid): Id de cadastro da conta beneficiária. - `bank` (string): Código do banco. - `account` (string): Número da conta - `branch` (string): Número da agência. - `taxpayerId` (string): Número do documento (CPF ou CNPJ) da conta de origem. - `name` (string): Nome do titular da conta. - `type` (string): Tipo da conta. Possíveis valores: **CC** - Conta Corrente; **CI** - Conta Investimento; **PG** - Conta de Pagamento; **PP** - Conta Poupança. - `key` (string): Chave PIX ##### Objeto 'balanceRetention' - `id` (string/uuid): Id da retenção. - `blockedAmount` (float): Valor total retido. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "name": "", "status": "ERROR", "startDate": "", "endDate": "", "amountPercentage": "", "origins": [ "", "" ], "shouldRetainSlc": "", "destination": { "id": "", "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" }, "createdAt": "", "description": "", "maxAmount": "", "balanceRetention": { "id": "", "blockedAmount": "" } }, { "id": "", "name": "", "status": "ACTIVE", "startDate": "", "endDate": "", "amountPercentage": "", "origins": [ "", "" ], "shouldRetainSlc": "", "destination": { "id": "", "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" }, "createdAt": "", "description": "", "maxAmount": "", "balanceRetention": { "id": "", "blockedAmount": "" } } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Alterar uma retenção](https://developers.celcoin.com.br/reference/patch_escrow-api-v1-accounts-account-id-deposit-retention-deposit-retention-id.md): Esse endpoint permite a alteração de uma regra de retenção previamente cadastrada na Conta. Regras para edição: - Só é possível editar uma retenção que esteja nos status 'CREATED' ou 'ACTIVE'. - Não é possível reduzir o 'valor máximo retido' para um valor que fique menor do que o valor retido atualmente. #### Parâmetros da URL - `account_id` (string): ID de cadastro da Conta. - `deposit_retention_id` (string): ID de cadastro da retenção a ser editada. #### Parâmetros da Requisição - `name` (string, obrigatório): O nome para identificação da regra. - `startDate` (string, obrigatório): Data de inicio para aplicação da regra de retenção na conta. Após essa data a retenção estará "ATIVA" e irá ser aplicada até a data final. - `endDate` (string, obrigatório): Data final para encerramento da regra de retenção. Após essa data a retenção não será mais aplicada e todo valor transacionado será enviado para a conta destinatária indicada via PIX (gerando tarifa normalmente). - `amountPercentage` (float, obrigatório): Valor percentual a ser aplicado na retenção dos valores transacionados. - `origins` (array, obrigatório): Lista de CPFs ou CNPJs para aplicar a regra de retenção. Se informada uma lista a regra de retenção só será aplicada se for transacionada por esses números de documentos. - `shouldRetainSlc` (boolean, obrigatório): Flag para indicar se a retenção também será aplicada em depósitos do tipo SLC, com as mesmas regras de PIX e TED. - `accountDestination` (string/uuid, obrigatório): ID de identificação da conta beneficiária, ou seja, conta que irá receber os valores retidos. - `description` (string): Descrição para detalhamento da regra e condições da retenção. - `maxAmount` (float): Valor máximo a ser retido. Deve ser estipulado um valor máximo que será retido na retenção cadastrada. Ao atingir esse valor a retenção automaticamente será bloqueada até a data final configurada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e em caso de algum erro será retornado um status 40X e uma mensagem informando o motivo. - [Excluir uma retenção](https://developers.celcoin.com.br/reference/delete_escrow-api-v1-accounts-account-id-deposit-retention-deposit-retention-id.md): Esse endpoint permite a exclusão de uma regra de retenção previamente cadastrada na Conta. Após a exclusão de uma retenção, ela ficará no estado de "REMOVED" e todo dinheiro bloqueado será desbloqueado automaticamente. Só é possível excluir retenções que estejam no status "ACTIVE" e "CREATED". #### Parâmetros da URL - `account_id` (string): ID de cadastro da Conta. - `deposit_retention_id` (string): ID de cadastro da retenção a ser editada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e em caso de algum erro será retornado um status 40X e uma mensagem informando o motivo. - [Listar todas as entidades de webhooks disponíveis para configuração](https://developers.celcoin.com.br/reference/get_escrow-api-v1-webhook-configurations.md): Esse endpoint permite a listagem de todas as entidades de webhooks que estão disponíveis para serem configuradas em uma conta escrow. #### Parâmetros da Requisição Não é necessário o envio de nenhum dado no corpo da requisição. #### Resposta Se a requisição for processada com sucesso, será retornado um status 200 e uma lista de objetos contendo os campos da entidade a ser retornada nos webhooks. ##### Exemplo de JSON: ``` json [ { "type": "object", "properties": { "amount": { "type": "number" }, "balance_type": { "type": "string" }, "movement_type": { "type": "string" }, "client_request_id": { "type": "string" }, "last_update_date": { "type": "string" }, "movement_account": { "type": "object", "properties": { "tax_id": { "type": "string" }, "name": { "type": "string" }, "branch": { "type": "string" }, "account": { "type": "string" } }, "required": [ "taxId", "name", "branch", "account" ], "additional_properties": false }, "approval_id": { "type": "string" }, "id": { "type": "string" }, "create_date": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } }, "required": [ "value", "key" ], "additional_properties": false } } }, "required": [ "amount", "balanceType", "movementType", "clientRequestId", "lastUpdateDate", "movementAccount", "approvalId", "id", "createDate", "tags" ], "additional_properties": false, "description": "SLC-PAYMENT-IN", "schema": "http://json-schema.org/draft-07/schema#" } ] ``` - [Criar uma configuração de webhook](https://developers.celcoin.com.br/reference/post_escrow-api-v1-accounts-account-id-webhook-configurations.md): Esse endpoint permite o cadastro de uma configuração para um webhook. É possivel cadastrar o recebimento de webhooks de cada entidade para cada conta escrow, mas por enquanto só está habilitado os webhooks de SLC. Os webhooks podem ser configurados de maneira distintas para cada ambiente (homologação/sandbox e produção). #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta a ser configurada. #### Parâmetros da Requisição - `webhookType` (string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos: - SLC_PAYMENT_IN = 'SLC-PAYMENT-IN', -> entrada de SLC - PIX_PAYMENT_IN = 'PIX-PAYMENT-IN', -> entrada de pix - PIX_PAYMENT_OUT = 'PIX-PAYMENT-OUT', -> saida de pix - SPB_TRANSFER_IN = 'SPB-TRANSFER-IN', -> entrada de ted - SPB_TRANSFER_OUT = 'SPB-TRANSFER-OUT', -> saida de ted - ACCOUNT_STATUS_CHANGE = 'ACCOUNT-STATUS-CHANGE', -> mudança de status no onboarding da conta - CHARGE_SETTLEMENT = 'CHARGE-SETTLEMENT', -> liquidação do boleto - CHARGE_CREATE = 'CHARGE-CREATE', -> criação do boleto - CHARGE_CANCELATION = 'CHARGE-CANCELATION', -> cancelamento / expiração de um boleto - `url` (string, obrigatório): A URL a ser cadastrada para o envio dos webhooks. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um ID do webhook configurada: - `id` (string/uuid): ID do webhook cadastrada. - [Listar todos os webhooks cadastrados para uma Conta](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-webhook-configurations.md): Esse endpoint permite a listagem de todos os webhooks que estão configurados para uma determinada conta escrow. #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta a ser configurada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON com uma lista de webhooks no seguinte formato: - `id` (string/uuid): ID do webhook cadastrado. - `status` (string): Status do webhook. Possíveis valores: 'ACTIVE', 'REMOVED' - `createdAt` (datetime): Data e hora que foi realizado o cadastro do webhook. - `webhookType` (string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos: - 'SLC-PAYMENT-IN' - 'SPB-TRANSFER-IN' - 'SPB-TRANSFER-OUT' - 'PIX-PAYMENT-IN' - 'PIX-PAYMENT-OUT' - 'ACCOUNT-STATUS-CHANGE' - `url` (string, obrigatório): A URL a ser cadastrada para o envio dos webhooks. - [Alterar uma configuração de webhook](https://developers.celcoin.com.br/reference/patch_escrow-api-v1-accounts-account-id-webhook-configurations-webhook-id.md): Esse endpoint permite a alteração de uma configuração de um determinado webhook. Os webhooks podem ser configurados de maneira distintas para cada ambiente (homologação/sandbox e produção). #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta. - `webhook_id` (string): ID de cadastro do webhook. #### Parâmetros da Requisição - `url` (string, obrigatório): A URL a ser cadastrada para o envio dos webhooks. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um ID do webhook configurada: - `id` (string/uuid): ID do webhook cadastrada. - [Excluir uma configuração de webhook](https://developers.celcoin.com.br/reference/delete_escrow-api-v1-accounts-account-id-webhook-configurations-webhook-id.md): Esse endpoint permite a exclusão de uma configuração de webhook de uma determinada conta escrow. #### Parâmetros da URL - `account_id` (string): ID de cadastro da conta. - `webhook_id` (string): ID de cadastro do webhook. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON vazio, confirmando a exclusão. - [Criar uma solicitação](https://developers.celcoin.com.br/reference/post_escrow-api-v1-postings.md): Esse endpoint permite a criação de uma solicitação para uma transação na conta escrow. Essa transação poderá ser do tipo TED, PIX ou o pagamento de um boleto bancário. ### Parâmetros da requisição - `accountId`(string, obrigatório): ID único para identificação da conta de origem dos recursos da transação. - `amount`(float, obrigatório): O valor total da transação para a solicitação. - `scheduledDate`(datetime): A data de agendamento para processamento da solicitação. - `type`(string, obrigatório): O tipo da transação que está sendo solicitada. Valores aceitos: TED, PIX e BOLETO. - `accountDestinationId`(string): ID único para identificação da conta de destino dos recursos da transação. - `barCode`(string): Código de barras do boleto bancário que está sendo pago. Campo de preenchimento obrigatório se tipo (type) for "BOLETO". - `billpaymentBeneficiary`(string): O nome do beneficiário do boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO". - `billpaymentPayer`(string): O nome do pagador do boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO". - `billpaymentTxnIdAuth`(string): ID de autorização da transação gerada para o boleto bancário. Campo de preenchimento obrigatório se tipo (type) for "BOLETO". Esse ID é retornado pelo endpoint "GET - Consultar os detalhes de um código de barras de boleto". - `clientFinality`(string, obrigatório): A finalidade que descreve a transação feita na solicitação. Possíveis valores: **1** - Pagamento de Impostos, Tributos e Taxas; **3** - Pagamentos de Dividendos; **4** - Pagamento de Salários; **5** - Pagamento de Fornecedores; **7** - Pagamento de Aluguéis e Taxas de Condomínio; **9** - Pagamento de Mensalidade Escolar; **10** - Crédito em Conta; **100** - Depósito Judicial; **110** - Transferência entre contas de mesma titularidade; **99999** - Outros - `description`(string): Descrição, detalhamento sobre a solicitação de transação que está sendo realizada. - `automaticallyApprove`(boolean): Campo do tipo boleano que indica se a solicitação que está sendo realizada deverá ser processada de forma automática ou não. ### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id`(string): ID para identificação da solicitação que foi criada na escrow. Exemplo de JSON: ``` json { "id": "string" } ``` - [Listar todas as solicitações](https://developers.celcoin.com.br/reference/get_escrow-api-v1-postings.md): Esse endpoint é responsável por retornar uma lista paginada de solicitações realizadas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. #### Parâmetros da Requisição - `status` (string): Status do processamento da solicitação. Possíveis valores aceitos: PENDING_APPROVAL, EXECUTING, REJECTED, EXPIRED, SCHEDULED, CANCELED, ERROR, SUCCESS. - `dateFrom` (datetime): Data de início da criação das solicitações. - `dateTo` (datetime): Data de fim da criação das solicitações. - `taxpayerId` (string): Nº do CPF ou CNPJ do pagador. - `account` (string): ID da conta para consulta das solicitações - `name` (string): Nome do participante. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, scheduledDate, type, amount, status. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - hasNext (boolean): Campo para indicar se tem uma próxima página. - totalElements (int): Quantidade total de registros retornados para a busca realizada. - totalPages (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string): ID para identificação da solicitação. - `status` (string): Status do processamento da solicitação. Possíveis valores: PENDING_APPROVAL, EXECUTING, REJECTED, EXPIRED, SCHEDULED, CANCELED, ERROR, SUCCESS. - `account` (object): Objeto contendo os dados da conta bancária. - `account -> id` (string): ID da conta bancária. - `account -> branch` (string): Número da agência. - `account -> account` (string): Número da conta. - `account -> person` (object): Objeto contendo os dados da pessoa, titular da conta. - `account -> person -> name` (string): Nome da pessoa. - `account -> person -> taxpayerId` (string): Número do CPF da pessoa. - `amount` (float): Valor da transação. - `type` (string): Tipo da transação. - `scheduledDate` (datetime): Data do agendamento para a solicitação. - `createdAt` (datetime): Data da criação da solicitação. - `review` (object): Objeto contendo os dados referente a parte de revisão da solicitação. - `review -> reviewBy` (object): Objeto contendo os detalhes do usuário revisor. - `review -> reviewBy -> id` (string, uuid v4): ID do usuário que fez a revisão da solicitação. - `review -> reviewBy -> fullName` (string): Nome completo do usuário que fez a revisão da solicitação. - `review -> reviewAt` (datetime): Data que foi feita a revisão. - `cancel` (object): Objeto contendo os dados referente a parte de cancelamento da solicitação. - `cancel -> cancelBy` (object): Objeto contendo os detalhes do usuário que cancelou. - `cancel -> cancelBy -> id` (string, uuid v4): ID do usuário que fez o cancelamento da solicitação. - `cancel -> cancelBy -> fullName` (string): Nome completo do usuário que fez o cancelamento da solicitação. - `cancel -> cancelBy` (datetime): Data que foi feita o cancelamento. - `accountDestination` (object): Objeto contendo os dados da conta de destino, se aplicável. - `accountDestination -> id` (string): ID da conta bancária. - `accountDestination -> branch` (string): Número da agência. - `accountDestination -> account` (string): Número da conta. - `accountDestination -> name` (string): Nome do beneficiário. - `accountDestination -> bank` (string): Código do banco. - `accountDestination -> type` (string): Tipo da conta. - `accountDestination -> taxpayerId` (string): Número do CPF do beneficiário. - `billpaymentBeneficiary` (string): Nome do beneficiário. - `billpaymentPayer` (string): Nome do pagador. - `barCode` (string): Código de barras no caso de uma solicitação de Boleto. - `error` (string): Retorno em caso de algum erro no processamento da solicitação. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "status": "EXPIRED", "account": { "id": "", "branch": "", "account": "", "person": { "name": "", "taxpayerId": "" } }, "amount": "", "type": "TED", "scheduledDate": "", "createdAt": "", "error": "", "review": { "reviewedBy": { "id": "", "fullName": "" }, "reviewedAt": "" }, "accountDestination": { "id": "", "name": "", "bank": "", "branch": "", "account": "", "type": "", "taxpayerId": "" }, "billpaymentBeneficiary": "", "billpaymentPayer": "", "barCode": "" } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Consultar os detalhes de uma solicitação realizada](https://developers.celcoin.com.br/reference/get_escrow-api-v1-postings-posting-id.md): Esse endpoint permite a consulta de uma solicitação realizada, retornando todos os dados pertinentes a solicitação, status atualizado do processamento, usuário responsável pela revisão e em casos de cancelamentos também será retornado os dados do usuário que cancelou a solicitação. #### Parâmetros da URL - `posting_id` (string): ID de identificação da solicitação a ser consultada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID para identificação da solicitação. - `status` (string): Status do processamento da solicitação. Possíveis valores: PENDING_APPROVAL, EXECUTING, REJECTED, EXPIRED, SCHEDULED, CANCELED, ERROR, SUCCESS. - `account` (object): Objeto contendo os dados da conta bancária. - `account -> id` (string): ID da conta bancária. - `account -> branch` (string): Número da agência. - `account -> account` (string): Número da conta. - `account -> person` (object): Objeto contendo os dados da pessoa, titular da conta. - `account -> person -> name` (string): Nome da pessoa. - `account -> person -> taxpayerId` (string): Número do CPF da pessoa. - `amount` (float): Valor da transação. - `type` (string): Tipo da transação. - `scheduledDate` (datetime): Data do agendamento para a solicitação. - `createdAt` (datetime): Data da criação da solicitação. - `review` (object): Objeto contendo os dados referente a parte de revisão da solicitação. - `review -> reviewBy` (object): Objeto contendo os detalhes do usuário revisor. - `review -> reviewBy -> id` (string, uuid v4): ID do usuário que fez a revisão da solicitação. - `review -> reviewBy -> fullName` (string): Nome completo do usuário que fez a revisão da solicitação. - `review -> reviewAt` (datetime): Data que foi feita a revisão. - `cancel` (object): Objeto contendo os dados referente a parte de cancelamento da solicitação. - `cancel -> cancelBy` (object): Objeto contendo os detalhes do usuário que cancelou. - `cancel -> cancelBy -> id` (string, uuid v4): ID do usuário que fez o cancelamento da solicitação. - `cancel -> cancelBy -> fullName` (string): Nome completo do usuário que fez o cancelamento da solicitação. - `cancel -> cancelBy` (datetime): Data que foi feita o cancelamento. - `accountDestination` (object): Objeto contendo os dados da conta de destino, se aplicável. - `accountDestination -> id` (string): ID da conta bancária. - `accountDestination -> branch` (string): Número da agência. - `accountDestination -> account` (string): Número da conta. - `accountDestination -> name` (string): Nome do beneficiário. - `accountDestination -> bank` (string): Código do banco. - `accountDestination -> type` (string): Tipo da conta. - `accountDestination -> taxpayerId` (string): Número do CPF do beneficiário. - `billpaymentBeneficiary` (string): Nome do beneficiário. - `billpaymentPayer` (string): Nome do pagador. - `barCode` (string): Código de barras no caso de uma solicitação de Boleto. - `error` (string): Retorno em caso de algum erro no processamento da solicitação. - `executedAt` (datetime): Data da execução da solicitação. ##### Exemplo de JSON: ``` json { "id": "", "status": "EXECUTING", "account": { "id": "", "branch": "", "account": "" }, "amount": "", "type": "PIX", "scheduledDate": "", "accountDestination": { "id": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" }, "barCode": "", "review": { "reviewedBy": { "id": "", "fullName": "" }, "reviewedAt": "" }, "cancel": { "canceledBy": { "id": "", "fullName": "" }, "canceledAt": "" }, "executedAt": "", "error": "" } ``` - [Revisar uma solicitação](https://developers.celcoin.com.br/reference/put_escrow-api-v1-postings-posting-id-review.md): Esse endpoint permite a realização da revisão de uma solicitação que esteja no status de pendente de aprovação (PENDING_APPROVAL). #### Parâmetros da Requisição - `posting_id` (string): ID de identificação da solicitação a ser consultada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200. - [Cancelar uma solicitação](https://developers.celcoin.com.br/reference/put_escrow-api-v1-postings-posting-id-cancel.md): Esse endpoint permite a realização do cancelamento de uma solicitação que esteja no status de agendada (SCHEDULED). #### Parâmetros da Requisição - `posting_id` (string): ID de identificação da solicitação a ser consultada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200. - [Consultar os detalhes de um código de barras de um boleto](https://developers.celcoin.com.br/reference/get_escrow-api-v1-billpayments-bar-code.md): Esse endpoint permite a realização de uma consulta detalhada dos dados de um boleto a partir de um código de barras. Nos dados retornados é possível validar diversas informações sendo elas: A categoria do pagamento é definida na propriedade type sendo, "1" para Concessionarias/Tributos e "2" para fichas de compensação. Nas consultas para fichas de compensação realizaremos a consulta CIP, retornando no agrupamento registerData todas as informações atualizadas. Para Concessionárias/Tributos extraímos as informações da linha digitável, sendo assim o mencionado agrupamento registerData não é retornado. Para consultas de fichas de compensação, retornamos o valor atualizado para o pagamento no campo "**totalUpdated**". Apenas nas consultas onde o "**AllowChangeValue**" for true, será possível efetivar o pagamento com um valor diferente do retornado no totalUpdated, lembrando que é necessário respeitar o intervalo máximo(maxValue) e mínimo(minValue). Disponibilizamos o intervalo que esse pagamento pode ser processado através nas propriedades **initeHour** e **EndHour**, desta forma é possível validar qual é a hora inicial e final do processamento do pagamento. Caso seja realizado a tentativa de pagamento fora desse horário de corte o pagamento será postergado para o próximo dia útil. É possível validar a data em que será realizada a liquidação do boleto através da propriedade **settleDate**. Também pode ser validado se o título será, ou não liquidado no o dia, através da propriedade nextSettle, onde **S** mostra que será liquidado no próximo dia útil e **N** que a liquidação será no mesmo dia. As vezes em ambiente de sandbox, pode ser que a propriedade **settleDate** seja populada como **null**, então recomendamos que seja realizado um tratamento para esse cenário do lado da sua aplicação, ou seja ela entenda que uma vez que populado com N a data de liquidação será no dia da confirmação do pagamento. O **transactionId** é o id da transação que foi criada para esse pagamento (_billpaymentTxnIdAuth)_. O **documentPayer** é o documento do pagador e o **value** é o valor do pagamento com descontos ou juros. Para alguns convênios de concessionária, não será possível realizar a extração da data de vencimento por meio da linha digitável, nesses casos, retornaremos o campo "**dueDate**" com o valor "**null**", e no momento da efetivação (billpayments) deve ser enviado a data em que está sendo realizado tal pagamento. Em ambiente de homologação a data de vencimento é mockada para qualquer convênio de concessionária, por isso retornará sempre "**null**". Porém, em produção, podemos retornar a data de vencimento corretamente em casos que o convênio a informa na linha digitável. Ou seja, em ambiente de produção, nós retornaremos no atributo "**dueDate**" o valor "**null**" quando o convênio não disponibiliza a data de vencimento, e retornaremos o valor correto da data de vencimento em formato de _Datetime_ nos casos em que temos a informação por parte do convênio. Por isso na integração os dois cenários devem ser considerados em produção. **OBS:** - Para contas do **tipo 1** (concessionárias/tributos), é necessário considerar sempre o atributo "**dueDate**", o qual refere-se a data de vencimento extraída na linha digitável do registro; - Para contas do **tipo 2** (ficha de compensação), é necessário considerar sempre o atributo "**registerData.dueDateRegister**", o qual refere-se a data de vencimento recuperada na consulta junto a CIP (Câmara Interbancária de Pagamentos). #### Parâmetros da URL - `bar_code` (string): Código de barras para consulta. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `assignor` (string (100)): Cedente do pagamento consultado. - `registerData` (object): Objeto contendo os dados de registro. - `settleDate` (datetime): Informa a data em que o pagamento será enviado para liquidação. - `dueDate` (datetime): Retorna a data de vencimento extraída do código. - `endHour` (string (5)): Informa a Hora corte do convênio (HH:MM). - `initeHour` (string (5)): Informa a Hora recebimento Inicial do convênio (HH:MM). - `nextSettle` (string (1)): Informa se o título será liquidado no próximo dia útil. Pode ser N ou S. - `digitable` (string (48)): Define a linha digitável consultada. - `transactionId` (bigInt): Protocolo de identificação da operação _(billpaymentTxnIdAuth)_. - `type` (int): Tipo de conta que está realizando a consulta. - `value` (float): Valor extraído do código. - `errorCode` (string (3)): Define o código status da operação. - `message` (string (100)): Informa descrição do erro. - `status` (string (30)): Define o status da operação. ##### Objeto 'registerData' - `documentRecipient` (string (18)): CPF ou CNPJ do beneficiário. - `documentPayer` (string (18)): CPF ou CNPJ do pagador. - `payDueDate` (datetime): Data de baixa do boleto. - `nextBusinessDay` (datetime): Próximo dia útil. - `dueDateRegister` (datetime): Data de vencimento do registro. - `allowChangeValue` (boolean): Indica que o Boleto permite alterar valor entre o range “maxValue” e “minValue”, sugerimos que caso seja retornado “True” libere que o usuário insira na efetivação (Billpayments) o valor desejado. - `recipient` (string (100)): Nome do beneficiário. - `payer` (string (100)): Nome do pagador. - `discountValue` (float): Valor do desconto calculado. - `interestValueCalculated` (float): Valor juros já calculado. - `maxValue` (float): Valor máximo permitido para pagamento do título. Utilizado nos cenários onde o “AllowChangeValue” for “True”. - `minValue` (float): Valor mínimo permitido para pagamento do título. Utilizado nos cenários onde o “AllowChangeValue” for “True”. - `fineValueCalculated` (float): Valor multa já calculado. - `originalValue` (float): Valor nominal do título. - `totalUpdated` (float): Valor atualizado a ser pago do título. Caso o campo “AllowChangeValue” retorne “False” apenas o valor retornado neste campo será aceito. - `totalWithDiscount` (float): Valor total de descontos e abatimentos. - `totalWithAdditional` (float): Valor total de juros e multa. ##### Exemplo de JSON: ``` json { "registerData": { "documentRecipient": "", "documentPayer": "", "payDueDate": "", "nextBusinessDay": "", "dueDateRegister": "", "allowChangeValue": "", "recipient": "", "payer": "", "discountValue": "", "interestValueCalculated": "", "maxValue": "", "minValue": "", "fineValueCalculated": "", "originalValue": "", "totalUpdated": "", "totalWithDiscount": "", "totalWithAdditional": "" }, "assignor": "", "settleDate": "", "dueDate": "", "endHour": "", "initeHour": "", "nextSettle": "", "digitable": "", "billpaymentTxnIdAuth": "", "type": "", "value": "", "maxValue": "", "minValue": "", "errorCode": "", "message": "", "status": "" } ``` - [Cadastrar uma nova carteira](https://developers.celcoin.com.br/reference/post_escrow-api-v1-wallets-1.md): Esse endpoint permite a realização do cadastro dos dados para uma nova carteira de cobrança para uma conta escrow. #### Parâmetros da Requisição - `name` (string): Nome da carteira. - `accountId` (string): ID de cadastro da conta para ser associada a nova carteira. - `daysToExpireAfterPayment` (integer): Quantidade de dias para expiração da cobrança. - `fine` (float): Taxa percentual de multa a ser aplicada nas cobranças com pagamento em atraso. - `discountModality` (string): Modalidade de desconto. Possíveis valores aceitos: PERCENT - `discountValue` (float): Valor de desconto a ser aplicado nos pagamentos. - `interest` (float): Taxa percentual de juros de atraso nos pagamentos. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id`(string/uuid v4): ID de cadastro gerado para a carteira de cobranças. ##### Exemplo de JSON: ``` json { "id": "" } ``` - [Listar todas as carteiras](https://developers.celcoin.com.br/reference/get_escrow-api-v1-wallets.md): Esse endpoint é responsável por retornar uma lista paginada de carteiras de cobrança. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. #### Parâmetros da Requisição - `name` (string): Nome. - `status` (string): Status da carteira. Possíveis valores aceitos: "ACTIVE", "ARCHIVED" - `walletCode` (string): ID, código de identificação da carteira. - `beneficiaryAccount` (string): Número da conta do beneficiário. - `beneficiaryDocument` (string): Número do CPF ou CNPJ do beneficiário. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status, account. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - hasNext (boolean): Campo para indicar se tem uma próxima página. - totalElements (int): Quantidade total de registros retornados para a busca realizada. - totalPages (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string): ID de cadastro da carteira. - `wallet_code` (string): Código de identificação para carteira. - `status` (string): Status do carteira. Possíveis valores: "ACTIVE", "ARCHIVED". - `name` (string): Nome do beneficiário. - `createdAt` (datetime): Data da criação da carteira. - `days_to_expire_after_payment` (integer): Dias de expiração. - `fine` (float): Percentual de multa. - `discount_modality` (string): Modalidade de desconto. - `discount_value` (float): Valor de desconto a ser aplicado. - `interest` (float): Taxa de juros. - `account` (object): Objeto contendo os dados da conta bancária. - `account -> id` (string): ID da conta. - `account -> branch` (string): Número da agência. - `account -> account` (string): Número da conta. - `account -> person` (object): Objeto contendo os dados da pessoa, titular da conta. - `account -> person -> name` (string): Nome da pessoa. - `account -> person -> taxpayerId` (string): Número do CPF da pessoa. - `account -> company` (object): Objeto contendo os dados da empresa, titular da conta. - `account -> company -> name` (string): Nome do titular da conta.. - `account -> company -> taxpayerId` (string): Número do CNPJ da empresa. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "wallet_code": "", "name": "", "status": "", "days_to_expire_after_payment": "", "createdAt": "", "fine": "", "discount_modality": "", "discount_value": "", "interest": "", "account": { "id": "", "branch": "", "account": "", "company": { "name": "", "taxpayerId": "" } } }, { "id": "", "wallet_code": "", "name": "", "status": "", "days_to_expire_after_payment": "", "createdAt": "", "fine": "", "discount_modality": "", "discount_value": "", "interest": "", "account": { "id": "", "branch": "", "account": "", "company": { "name": "", "taxpayerId": "" } } } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Consultar os detalhes de uma carteira](https://developers.celcoin.com.br/reference/get_escrow-api-v1-wallets-wallet-id.md): Esse endpoint permite a realização de uma consulta detalhada dos dados de cadastro de uma carteira de cobranças associada a uma conta. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. #### Parâmetros da Requisição Não é necessário o envio de nenhum dado no corpo da requisição. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID de cadastro da carteira. - `wallet_code` (string): Código de identificação para carteira. - `status` (string): Status do carteira. Possíveis valores: "ACTIVE", "ARCHIVED". - `name` (string): Nome do beneficiário. - `createdAt` (datetime): Data da criação da carteira. - `days_to_expire_after_payment` (integer): Dias de expiração. - `fine` (float): Taxa percentual de multa a ser aplicada em caso de atraso no pagamento. - `discount_modality` (string): Modalidade de desconto. - `discount_value` (float): Valor de desconto a ser aplicado. - `interest` (float): Taxa de juros em caso de atraso no pagamento. - `account` (object): Objeto contendo os dados da conta bancária. - `account -> id` (string): ID da conta. - `account -> branch` (string): Número da agência. - `account -> account` (string): Número da conta. - `account -> person` (object): Objeto contendo os dados da pessoa, titular da conta, caso seja uma pessoa física.. - `account -> person -> name` (string): Nome da pessoa. - `account -> person -> taxpayerId` (string): Número do CPF da pessoa. - `account -> company` (object): Objeto contendo os dados da empresa, titular da conta, caso seja uma pessoa jurídica.. - `account -> company -> name` (string): Nome do titular da conta.. - `account -> company -> taxpayerId` (string): Número do CNPJ da empresa. ##### Exemplo de JSON: ``` json { "id": "", "name": "", "wallet_code": "", "fine": "", "days_to_expire_after_payment": "", "discount_modality": "", "discount_value": "", "interest": "", "status": "", "account": { "id": "", "person": { "id": "", "name": "", "taxpayerId": "" }, "branch": "", "account": "" } } ``` - [Alterar os dados de uma carteira](https://developers.celcoin.com.br/reference/patch_escrow-api-v1-wallets-wallet-id.md): Esse endpoint permite a realização de alterações nos dados cadastrais de uma carteira. #### Parâmetros da URL - `wallet_id` (string): ID da carteira a ser atualizada. #### Parâmetros da Requisição - `name` (string): Nome. - `accountId` (string): ID de cadastro da conta a ser associada. - `daysToExpireAfterPayment` (integer): Dias de expiração. - `fine` (float): Percentual de multa. - `discountModality` (string): Modalidade de desconto. Possíveis valores aceitos: PERCENT - `discountValue` (float): Valor de desconto a ser aplicado. - `interest` (float): Taxa de juros. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id`(string/uuid v4): ID de cadastro gerado para a carteira. ##### Exemplo de JSON: ``` json { "id": "" } ``` - [Arquivar ou desarquivar uma carteira](https://developers.celcoin.com.br/reference/put_escrow-api-v1-wallets-wallet-id-archive.md): Esse endpoint permite a realização do arquivamento ou desarquivamento de uma determinada carteira de cobranças. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. #### Parâmetros da Requisição - `revert` (string): Campo utilizado para desarquivar uma carteira que esteja arquivada. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON sem conteúdo. ##### Exemplo de resposta: ``` json {} ``` - [Criar uma nova conta de destino (transferências)](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-accountid-destinations.md): Esse endpoint é responsável por criar uma nova conta de destino, essa conta será utilizada posteriormente no processo de transferências de recursos. ### Parâmetros da URL - `account_id` (string): ID de cadastro para identificação da conta a ser consultada. ### Parâmetros da Requisição - `taxpayerId` (string): Nº do documento do titular da conta de destino (CPF ou CNPJ); - `name` (string): Nome ou razão social do titular; - `bank` (string): Código ISPB do banco da conta de destino; - `branch` (string): Número da agência da conta de destino; - `account` (string): Número da conta de destino; - `type` (string): Tipo da conta de destino. Possíveis valores aceitos: 'CACC', 'SVGS', 'TRAN', 'SLRY', 'CI'; - **CACC**: Conta Corrente (Normal ou contas digitais). - **TRAN**: Conta de Pagamento (Pré-paga). - **SVGS**: Conta Poupança. - **SLRY**: Conta Salário. - **CI**: Conta Investimento. #### Exemplo de JSON de requisição ``` json { "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" } ``` ### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID para identificação da solicitação cadastrada. #### Exemplo de JSON: ``` json { "id": "" } ``` - [Excluir uma conta de destino](https://developers.celcoin.com.br/reference/delete_escrow-api-v1-accounts-accountid-destinations-accountdestinationid.md): Esse endpoint é responsável por excluir uma conta de destino já cadastrada no sistema da Escrow. ### Parâmetros da URL - `account_id` (string): ID de cadastro da conta de origem; - `account_destination_id` (string): ID de cadastro da conta de destino; ### Resposta Se a requisição for processada com sucesso será retornado um código 200 confirmando a exclusão da conta de destino. - [Alterar uma conta de destino](https://developers.celcoin.com.br/reference/patch_escrow-api-v1-accounts-accountid-destinations-accountdestinationid.md): Esse endpoint é responsável por alterar os dados de uma conta de destino já cadastrada no sistema da Escrow. ### Parâmetros da URL - `account_id` (string): ID de cadastro da conta de origem; - `account_destination_id` (string): ID de cadastro da conta de destino; ### Parâmetros da Requisição - `taxpayerId` (string): Nº do documento do titular da conta de destino (CPF ou CNPJ); - `name` (string): Nome ou razão social do titular; - `bank` (string): Código ISPB do banco da conta de destino; - `branch` (string): Número da agência da conta de destino; - `account` (string): Número da conta de destino; - `type` (string): Tipo da conta de destino. Possíveis valores aceitos: 'CACC', 'SVGS', 'TRAN', 'SLRY', 'CI'; #### Exemplo de JSON de requisição ``` json { "taxpayerId": "", "name": "", "bank": "", "branch": "", "account": "", "type": "" } ``` ### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID para identificação da solicitação cadastrada. #### Exemplo de JSON: ``` json { "id": "" } ``` - [Cadastrar Cobrança](https://developers.celcoin.com.br/reference/post_escrow-api-v1-wallets-wallet-id-charges-1.md): Este endpoint permite **criar cobranças**, **processar pagamentos**, **consultar detalhes** e **receber notificações via Webhook** sobre eventos do ciclo de vida de uma cobrança. --- ## Autenticação ``` Authorization: Bearer {API_TOKEN} Content-Type: application/json ``` --- ## Criar Cobrança Cria uma nova cobrança com regras de desconto, juros, multa, split e dados completos do pagador. ### **POST** `/charges` --- ### Request Body — Parâmetros #### Dados principais da cobrança | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | `due_date` | datetime | Sim | Data de vencimento da cobrança (ISO 8601). | | `amount` | float | Sim | Valor total da cobrança. | | `fine` | float | Não | Percentual de multa por atraso. | | `interest` | float | Não | Percentual de juros aplicado após o vencimento. | | `discount_limit_date` | datetime | Não | Data limite para aplicação do desconto. | | `discount_modality` | string | Não | Modalidade do desconto: `FIXED` ou `PERCENT`. | | `discount_value` | float | Não | Valor do desconto, conforme a modalidade definida. | --- #### Objeto `charge_debtor` — Dados do Pagador | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | `number` | string | Não | Número do endereço. | | `neighborhood` | string | Não | Bairro. | | `name` | string | Sim | Nome completo do pagador. | | `document` | string | Sim | Documento do pagador (CPF ou CNPJ). | | `city` | string | Não | Cidade. | | `public_area` | string | Não | Logradouro (rua, avenida, etc.). | | `state` | string | Não | Estado (UF). | | `postal_code` | string | Não | CEP. | | `country_code` | string | Não | Código do país (ex: `BR`). | | `phone_code` | string | Não | Código do país para telefone (ex: `+55`). | | `number_phone` | string | Não | Número do telefone. | | `email` | string | Não | E-mail do pagador. | --- #### Objeto `charge_split` — Split de Pagamento | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | `account_destination_id` | string | Sim | Identificador da conta recebedora do split. | | `split_type` | string | Sim | Tipo de split: `PERCENTAGE` ou `AMOUNT`. | | `split_percentage` | float | Não | Percentual do valor destinado ao split. Obrigatório quando `split_type = PERCENTAGE`. | | `split_amount` | float | Não | Valor fixo destinado ao split. Obrigatório quando `split_type = AMOUNT`. | --- ### Response — Sucesso ``` { "id": "chg_123456" } ``` | Campo | Tipo | Descrição | | --- | --- | --- | | `id` | string | Identificador único da cobrança. | --- ## Processamento da Cobrança Após a criação, a cobrança é processada de forma assíncrona. O resultado é enviado via Webhook conforme o status do processamento. --- ## Webhook — Cobrança Criada com Sucesso Evento disparado quando a cobrança é registrada com sucesso. ### Event ``` charge.created ``` ### Payload — Parâmetros | Campo | Tipo | Descrição | | --- | --- | --- | | `charge_id` | string | Identificador da cobrança. | | `pix_code` | string | Código PIX para pagamento. | | `digitable_line` | string | Linha digitável do boleto. | | `bank_number` | string | Código do banco emissor. | | `pix_base64` | string | QR Code PIX em Base64. | | `client_code` | string | Código do cliente. | | `link_boleto` | string | URL para acesso ao boleto. | --- ## Webhook — Erro na Criação da Cobrança Evento disparado quando ocorre falha no processamento. ### Event ``` charge.error ``` ### Payload — Parâmetros | Campo | Tipo | Descrição | | --- | --- | --- | | `charge_id` | string | Identificador da cobrança. | | `client_code` | string | Código do cliente. | | `status` | string | Status do processamento (`ERROR`). | | `error` | string | Mensagem detalhando o erro ocorrido. | --- ## Consultar Detalhes da Cobrança Retorna todas as informações da cobrança, incluindo pagamento, boleto, PIX e splits. ### **GET** `/charges/{charge_id}` --- ### Response — Parâmetros #### Dados gerais | Campo | Tipo | Descrição | | --- | --- | --- | | `id` | string | Identificador da cobrança. | | `amount` | number | Valor total da cobrança. | | `charge_code` | number | Código interno da cobrança. | | `due_date` | date | Data de vencimento. | | `amount_paid` | number | Valor efetivamente pago. | | `paid_amount` | number | Valor liquidado. | | `fees` | number | Taxas aplicadas. | | `interest` | number | Juros aplicados. | | `discount_modality` | string | Modalidade do desconto. | | `discount_value` | number | Valor do desconto. | | `discount_limit_date` | date | Data limite para desconto. | | `taxes_to_apply_after_payment` | number | Taxas aplicáveis após pagamento. | --- #### Dados de pagamento | Campo | Tipo | Descrição | | --- | --- | --- | | `bar_code` | string | Código de barras do boleto. | | `pix_code` | string | Código PIX. | | `pix_detail` | string | Descrição do pagamento PIX. | | `boleto_details` | object | Informações adicionais do boleto. | | `charge_pdf_url` | string | URL do PDF do boleto. | --- #### Objeto `charge_receiver` | Campo | Tipo | Descrição | | --- | --- | --- | | `account` | string | Conta recebedora. | | `document` | string | Documento do recebedor. | --- #### Objeto `split` (array) | Campo | Tipo | Descrição | | --- | --- | --- | | `account` | string | Conta beneficiária do split. | | `document` | string | Documento do beneficiário. | | `split_type` | string | Tipo do split (`PERCENTAGE` ou `AMOUNT`). | | `split_percentage` | string | Percentual do split. | | `split_amount` | string | Valor fixo do split. | --- ## Status da Cobrança | Status | Descrição | | --- | --- | | `CREATED` | Cobrança criada. | | `PROCESSING` | Em processamento. | | `PAID` | Cobrança paga. | | `EXPIRED` | Cobrança vencida. | | `ERROR` | Erro no processamento. | - [Listar todas as cobranças de uma carteira](https://developers.celcoin.com.br/reference/get_escrow-api-v1-wallets-wallet-id-charges.md): Esse endpoint é responsável por retornar uma lista paginada de cobranças da carteira. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. #### Parâmetros da Requisição - `chargeCode` (string): Código da cobrança. - `status` (string): Status da cobrança. Possíveis valores aceitos: - `taxpayerId` (string): Número do CPF ou CNPJ do pagador. - `debtorName` (string): Nome do devedor. - `minCreatedAt` (datetime): Data início para filtro por data de cadastro da cobrança. - `maxCreatedAt` (datetime): Data final para filtro por data de cadastro da cobrança. - `minDueDate` (datetime): Data início para filtro por data de vencimento da cobrança. - `maxDueDate` (datetime): Data final para filtro por data de vencimento da cobrança. - `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status, account. - `updatedAt` (datetime): Data da última atualização. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `content`(object list): Objeto contendo a lista com o resultado do filtro realizado. - hasNext (boolean): Campo para indicar se tem uma próxima página. - totalElements (int): Quantidade total de registros retornados para a busca realizada. - totalPages (int): Quantidade total de páginas retornadas para a busca realizada. ##### Objeto 'content' - `id` (string): ID de cadastro da cobrança. - `chargeCode` (string): Código de identificação para cobrança. - `status` (string): Status da cobrança. Possíveis valores: - `discount_limit_date` (datetime): Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20. - `created_at` (datetime): Data da criação da cobrança. - `days_to_expire_after_payment` (integer): Dias após o vencimento que a cobraça pode ser paga. - `fine` (float): Percentual de multa a ser aplicada em caso de atraso no pagamento. - `discount_modality` (string): Modalidade de desconto. - `discount_value` (float): Valor de desconto a ser aplicado. - `interest` (float): Taxa de juros em caso de atraso no pagamento. - `receiver` (object): Objeto contedo os dados do recebedor. - `debtor` (object): Objeto contendo os dados do devedor. - `updatedAt` (datetime): Data da última atualização. - `paid_at` (datetime): Data da confirmação do pagamento, se for 'bolepix' o status será alterado para 'CONFIRMED'. - `payed_amount` (float): Valor total pago. - `bar_code` (string): Código de barras do boleto de pagamento. - `pix_code` (string): Código PIX do pagamento. - `boleto_details` (string): Objeto contendo os detalhes referente ao tipo de pagamento se boleto. - `pix_details` (string): Objeto contendo os detalhes referente ao tipo de pagamento se pix. ##### Objeto 'receiver' - `account` (string): Número da conta. - `document` (string): Número do documento de identificação do recebedor. ##### Objeto 'debtor' - `number` (string): Número do endereço informado. - `name` (string): Nome da rua. - `postal_code` (string): Código de CEP para o endereço. - `neighborhood` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `state` (string): Código da UF para o estado do endereço. - `public_area` (string): Complemento. ##### Objeto 'boleto_details' - `transactionId` (string): ID da transação. - `status` (string): Status do processamento. - `bankEmissor` (string): Nome do banco emissor do boleto. - `bankNumber` (string): Código de identificação do banco. - `bankAgency` (string): Código da agência do banco. - `bankAccount` (string): Número da conta. - `barCode` (string): Código de barras do boleto. - `bankLine` (string): Linha digitável do boleto. - `bankAssignor` (string): Nome da instituição emissora. ##### Objeto 'pix_details' - `transactionId` (string): ID da transação. - `transactionIdentification` (string): Identificação da transação. - `status` (string): Status do processamento. - `key` (string): Chave PIX utilizada no pagamento. - `emv` (string): Código de barras/QRCode do PIX. ##### Exemplo de JSON: ``` json { "content": [ { "id": "", "fine": "", "chargeCode": "", "status": "", "discount_limit_date": "", "due_date": "", "amount": "", "days_to_expire_after_payment": "", "discount_modality": "", "discount_value": "", "interest": "", "created_at": "", "receiver": { "account": "", "document": "" }, "debtor": { "number": "", "neighborhood": "", "name": "", "document": "", "city": "", "public_area": "", "state": "", "postal_code": "" }, "error": "", "updated_at": "", "paid_at": "", "payed_amount": "", "bar_code": "", "pix_code": "", "boleto_details": { "transactionId": "", "status": "", "bankEmissor": "", "bankNumber": "", "bankAgency": "", "bankAccount": "", "barCode": "", "bankLine": "", "bankAssignor": "" }, "pix_details": { "transactionId": "", "transactionIdentification": "", "status": "", "key": "", "emv": "" } }, { "id": "", "fine": "", "chargeCode": "", "status": "", "discount_limit_date": "", "due_date": "", "amount": "", "days_to_expire_after_payment": "", "discount_modality": "", "discount_value": "", "interest": "", "created_at": "", "receiver": { "account": "", "document": "" }, "debtor": { "number": "", "neighborhood": "", "name": "", "document": "", "city": "", "public_area": "", "state": "", "postal_code": "" }, "error": "", "updated_at": "", "paid_at": "", "payed_amount": "", "bar_code": "", "pix_code": "", "boleto_details": { "transactionId": "", "status": "", "bankEmissor": "", "bankNumber": "", "bankAgency": "", "bankAccount": "", "barCode": "", "bankLine": "", "bankAssignor": "" }, "pix_details": { "transactionId": "", "transactionIdentification": "", "status": "", "key": "", "emv": "" } } ], "hasNext": "", "totalElements": "", "totalPages": "" } ``` - [Consultar os detalhes de uma cobrança](https://developers.celcoin.com.br/reference/get_escrow-api-v1-wallets-wallet-id-charges-charge-id.md): Esse endpoint permite que seja realizada uma consulta detalhada de uma cobrança que foi realizada na carteira. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. - `charge_id` (string/uuid v4): ID de cadastro da cobrança. #### Parâmetros da Requisição Não é necessário o envio de nenhum dado no corpo da requisição. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato: - `id` (string): ID de cadastro da cobrança. - `charge_code` (string): Código de identificação para cobrança. - `discount_limit_date` (datetime): Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20. - `created_at` (datetime): Data da criação da cobrança. - `days_to_expire_after_payment` (integer): Quantidade de dias após o vencimento que a cobraça pode ser paga. - `fine` (float): Percentual de multa a ser aplicada em caso de atraso no pagamento. - `discount_modality` (string): Modalidade de desconto. Possíveis valores: - FIXED: Para aplicar um desconto em valor ex: R$ 2,50 - PERCENT: Para aplicar um desconto em porcentagem ex: 10.00% - `discount_value` (float): Valor de desconto a ser aplicado. - `interest` (float): Taxa de juros em caso de atraso no pagamento. - `charge_receiver` (object): Objeto contedo os dados do recebedor. - `charge_debtor` (object): Objeto contendo os dados do devedor. - `updated_at` (datetime): Data da última atualização. - `paid_at` (datetime): Data da confirmação do pagamento, se for 'bolepix' o status será alterado para 'CONFIRMED'. - `payed_amount` (float): Valor total pago. - `bar_code` (string): Código de barras do boleto de pagamento. - `pix_code` (string): Código PIX do pagamento. - `boleto_details` (string): Objeto contendo os detalhes referente ao tipo de pagamento se boleto. - `pix_details` (string): Objeto contendo os detalhes referente ao tipo de pagamento se pix. ##### Objeto 'charge_receiver' - `account` (string): Número da conta. - `document` (string): Número do documento de identificação do recebedor. ##### Objeto 'charge_debtor' - `name` (string): Nome do pagador. - `document` (string): CPF do pagador. - `email` (string): E-mail de contato. - `publicArea` (string): Nome da rua. - `number` (string): Número do endereço informado. - `postalCode` (string): Código de CEP para o endereço. - `neighborhood` (string): Campo para informar o bairro. - `city` (string): Nome da cidade. - `state` (string): Código da UF para o estado do endereço. - `complement` (string): Complemento do endereço. ##### Objeto 'boleto_details' - `transactionId` (string): ID da transação. - `status` (string): Status do processamento. - `bankEmissor` (string): Nome do banco emissor do boleto. - `bankNumber` (string): Código de identificação do banco. - `bankAgency` (string): Código da agência do banco. - `bankAccount` (string): Número da conta. - `barCode` (string): Código de barras do boleto. - `bankLine` (string): Linha digitável do boleto. - `bankAssignor` (string): Nome da instituição emissora. ##### Objeto 'pix_details' - `transactionId` (string): ID da transação. - `transactionIdentification` (string): Identificação da transação. - `status` (string): Status do processamento. - `key` (string): Chave PIX utilizada no pagamento. - `emv` (string): Código de barras/QRCode do PIX. ##### Exemplo de JSON: ``` json { "id": "", "fine": "", "charge_code": "", "due_date": "", "amount": "", "discount_limit_date": "", "days_to_expire_after_payment": "", "discount_modality": "FIXED", "discount_value": "", "interest": "", "charge_debtor": { "number": "", "neighborhood": "", "name": "", "document": "", "city": "", "public_area": "", "state": "", "postal_code": "" }, "charge_receiver": { "account": "", "document": "" }, "updated_at": "", "paid_at": "", "payed_amount": "", "bar_code": "", "pix_code": "", "boleto_details": { "transactionId": "", "status": "", "bankEmissor": "", "bankNumber": "", "bankAgency": "", "bankAccount": "", "barCode": "", "bankLine": "", "bankAssignor": "" }, "pix_details": { "transactionId": "", "transactionIdentification": "", "status": "", "key": "", "emv": "" } } ``` - [Excluir uma cobrança](https://developers.celcoin.com.br/reference/delete_escrow-api-v1-wallets-wallet-id-charges-charge-id.md): Esse endpoint permite a exclusão de uma cobrança cadastrada em uma determinada carteira. Para efetivar a exclusão é necessário informar um motivo para registro. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. - `charge_id` (string/uuid v4): ID de cadastro da cobrança. #### Parâmetros da Requisição - `reason` (string): Motivo da exclusão da cobrança. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON. - [Baixar o PDF de uma cobrança](https://developers.celcoin.com.br/reference/get_escrow-api-v1-wallets-wallet-id-charges-charge-id-pdf.md): Esse endpoint permite a consulta do endereço (URL) para download de um arquivo do tipo PDF de uma cobrança da carteira. #### Parâmetros da URL - `wallet_id` (string/uuid v4): ID de cadastro da wallet. - `charge_id` (string/uuid v4): ID de cadastro da cobrança. #### Parâmetros da Requisição Não é necessário o envio de nenhum dado no corpo da requisição. #### Resposta Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato. - charge_pdf_url (string): URL (path) para download de um arquivo PDF da cobrança. Exemplo de JSON: ``` json { "charge_pdf_url": "" } ``` - [Cadastrar uma nova cobrança (PIX)](https://developers.celcoin.com.br/reference/post_escrow-api-v1-accounts-account-id-pix-charges.md): Cria uma nova cobrança PIX associada a uma conta escrow específica na Plataforma Celcoin. A cobrança gerada possui data de vencimento, regras de juros e expiração após o pagamento, permitindo a liquidação via QR Code ou código EMV. Este endpoint possibilita o registro completo da cobrança, incluindo: - Valor da cobrança - Dados do devedor (pagador) - Data de vencimento - Regras de juros - Prazo de expiração após o pagamento A cobrança criada poderá ser consultada posteriormente e utilizada para pagamento via PIX. --- ## Descrição Este endpoint permite criar uma cobrança PIX vinculada a uma conta escrow específica, identificada pelo `account_id`. A operação registra a cobrança na plataforma e retorna todas as informações necessárias para pagamento, como QR Code, código EMV e URL de pagamento. --- ## Método HTTP **POST** --- ## URL **Plain Text** ``` https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts/{account_id}/pix-charges ``` --- ## Path Parameters | Nome | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | account_id | string | Sim | Identificador único da conta escrow na Plataforma Celcoin. Garante que a cobrança será criada na conta correta. | --- ## Headers | Nome | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | Authorization | string | Sim | Token de autenticação no formato `Bearer {token}`. Responsável por autenticar e autorizar o acesso ao endpoint. | | Content-Type | string | Sim | Deve ser informado como `application/json`. | --- ## Body Parameters ### Dados da Cobrança | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | amount | number | Sim | Valor da cobrança PIX. | | dueDate | string | Sim | Data de vencimento da cobrança no formato ISO 8601 (`YYYY-MM-DD`). | | expirationAfterPayment | integer | Não | Prazo, em dias, para expiração da cobrança após o pagamento. | | interestAmount | number | Não | Valor do juros aplicado à cobrança. | | interestType | string | Não | Tipo de juros. Exemplo: `PERCENTAGE_PER_MONTH_CALENDAR_DAYS`. | --- ### Debtor (Objeto) Dados do pagador da cobrança. | Campo | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | name | string | Sim | Nome do pagador. | | taxpayerId | string | Sim | CPF ou CNPJ do pagador (somente números). | | type | string | Sim | Tipo do pagador. Valores aceitos: `PERSON`, `COMPANY`. | --- ## Exemplo de Requisição **Plain Text** ``` POST /escrow/api/v1/accounts/123456/pix-charges Authorization: Bearer {token} Content-Type: application/json ``` ``` { "amount": 5, "debtor": { "name": "Não informado", "taxpayerId": "32383861820", "type": "PERSON" }, "dueDate": "2026-01-15", "expirationAfterPayment": 5, "interestAmount": 0, "interestType": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS" } ``` --- ## Resposta de Sucesso ### Status: **201 Created** Retorna os dados completos da cobrança PIX criada, incluindo identificadores, informações de pagamento e dados do devedor. **Exemplo de Resposta** ``` { "id": "17f78e3e-0064-4231-8b76-c0a33301d797", "amount": "5.00", "description": null, "due_date": "2026-01-15", "expiration_after_payment": "5", "status": "ACTIVE", "pix_key": "eafccd5d-7df7-4aa2-8b98-38561664f092", "pre_signed_url": "https://s3.sa-east-1.amazonaws.com/...", "interest_amount": 0, "interest_type": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS", "discount_amount": null, "discount_type": null, "fine_amount": null, "fine_type": null, "emv": "0002010102122698...", "url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/...", "debtor": { "taxpayer_id": "32383861820", "name": "Não informado", "email_address": null, "address": null }, "created_at": "2026-01-15T14:14:26.635Z" } ``` --- ## Códigos de Retorno Padrão | Status Code | Descrição | | --- | --- | | **201 Created** | Cobrança PIX criada com sucesso. | | **400 Bad Request** | Dados inválidos ou malformados na requisição. | | **401 Unauthorized** | Token de autenticação ausente ou inválido. | | **403 Forbidden** | Acesso não autorizado à conta escrow informada. | | **404 Not Found** | Conta escrow não encontrada. | | **422 Unprocessable Entity** | Regras de negócio violadas (ex: data inválida, valor inconsistente). | | **500 Internal Server Error** | Erro interno inesperado na plataforma. | - [Consultar uma cobrança (PIX)](https://developers.celcoin.com.br/reference/get_escrow-api-v1-accounts-account-id-pix-charges-pix-charge-id.md): Retorna os dados de uma cobrança PIX previamente criada, vinculada a uma conta escrow específica na Plataforma Celcoin. Este endpoint permite recuperar todas as informações da cobrança, incluindo: - Status atual - Valores e encargos - Datas de vencimento e expiração - Dados do devedor - QR Code (EMV) - URL de pagamento - Metadados associados à cobrança --- ### Descrição Este endpoint permite consultar uma cobrança PIX específica, identificada pelo `pix_charge_id`, associada a uma conta escrow identificada pelo `account_id`. A operação é exclusivamente de consulta (**GET**) e **não altera o estado da cobrança**. --- ### Método HTTP `GET` --- ### URL ``` https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts/{account_id}/pix-charges/{pix_charge_id} ``` --- ### Path Parameters | Nome | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | `account_id` | string | Sim | Identificador único da conta escrow na Plataforma Celcoin. Garante que a cobrança consultada pertence à conta correta. | | `pix_charge_id` | string | Sim | Identificador único da cobrança PIX previamente criada. Permite localizar de forma precisa a cobrança a ser consultada. | --- ### Headers | Nome | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | `Authorization` | string | Sim | Token de autenticação no formato `Bearer {token}`. | | `Content-Type` | string | Sim | Deve ser informado como `application/json`. | --- ### Body Parameters Este endpoint **não possui corpo de requisição**, pois se trata de uma operação de consulta (`GET`). --- ### Exemplo de Requisição ``` GET /escrow/api/v1/accounts/123456/pix-charges/17f78e3e-0064-4231-8b76-c0a33301d797 Authorization: Bearer {token} Content-Type: application/json ``` --- ## Respostas ### Sucesso **Status:** `200 OK` Retorna os dados completos da cobrança PIX consultada. #### Exemplo de Resposta ``` { "id": "17f78e3e-0064-4231-8b76-c0a33301d797", "amount": "5.00", "description": null, "due_date": "2026-01-15", "expiration_after_payment": "5", "status": "ACTIVE", "pix_key": "eafccd5d-7df7-4aa2-8b98-38561664f092", "pre_signed_url": "https://s3.sa-east-1.amazonaws.com/sandbox.api.escrow.temp.uploads/...", "interest_amount": 0, "interest_type": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS", "discount_amount": null, "discount_type": null, "discount_dates_settings": null, "fine_amount": null, "fine_type": null, "emv": "00020101021226980014br.gov.bcb.pix2576qrcode-h.pix.celcoin.com.br/...", "url": "qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/9b737c7eeeead59e0be8b08a99af90", "debtor": { "taxpayer_id": "32383861820", "name": "Não informado", "email_address": null, "address": null }, "created_at": "2026-01-15T14:14:26.635Z" } ``` --- ### Códigos de Erro | Status Code | Descrição | Quando ocorre | | --- | --- | --- | | `400 Bad Request` | Requisição inválida | Parâmetros malformados ou IDs em formato inválido | | `401 Unauthorized` | Não autorizado | Token ausente, inválido ou expirado | | `403 Forbidden` | Acesso negado | Token válido, porém sem permissão para acessar a conta | | `404 Not Found` | Recurso não encontrado | Cobrança PIX ou conta escrow não encontrada | | `409 Conflict` | Conflito de estado | Inconsistência no estado atual da cobrança | | `422 Unprocessable Entity` | Erro de validação | Dados válidos sintaticamente, mas inconsistentes semanticamente | | `500 Internal Server Error` | Erro interno | Falha inesperada no servidor | | `503 Service Unavailable` | Serviço indisponível | Instabilidade ou manutenção da plataforma | - [Obter o status do serviço.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-healthcheck-1.md): Método para verificar a saúde do serviço. - [Criar aplicação](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications.md): Cria uma nova aplicação com credenciais de cliente OAuth2 no Keycloak. Configura automaticamente contas, redirecionamentos e configurações padrão se configuradas. Retorna a aplicação com segredo do cliente para configuração inicial. - [Listar aplicações](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications.md): Lista todas as aplicações que o usuário autenticado tem acesso. Retorna aplicações baseadas nas permissões de autorização do usuário e acesso aos recursos. - [Obter detalhes da aplicação](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid.md): Recupera informações detalhadas sobre uma aplicação específica incluindo todos os recursos relacionados como contas, redirecionamentos, webhooks, configurações e jornadas. - [Atualizar aplicação](https://developers.celcoin.com.br/reference/put_open-keys-itp-api-v2-applications-applicationid.md): Atualiza a configuração e metadados de uma aplicação existente. Apenas informações básicas da aplicação podem ser modificadas, as credenciais OAuth2 permanecem inalteradas. - [Criar sessão de jornada de pagamento](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-journeys-journeyid-sessions.md): Cria uma nova sessão de jornada de pagamento para fins de teste. Isso inicia um fluxo de pagamento que pode ser usado para simular interações de usuários finais com o sistema de pagamento. Suporta fluxos de pagamento padrão e redirecionamentos de inscrição. - [Criar sessão de gestão do usuário final](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-management-sessions.md): Cria uma URL de sessão de gestão para fins de teste do usuário final. Isso gera uma sessão segura que permite aos usuários autorizados gerenciar e configurar definições da aplicação, testar cenários de usuário e executar tarefas administrativas dentro do contexto da aplicação. - [Criar conta credora](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-accounts.md): Cria uma nova conta credora para a aplicação. A conta será usada para receber pagamentos e deve incluir informações bancárias válidas, incluindo número da conta, agência e detalhes do banco. Valida duplicatas antes da criação. - [Listar contas credoras](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-accounts.md): Lista todas as contas credoras associadas a um determinado identificador de aplicação. Os resultados incluem metadados relevantes da conta, como números de conta, tipos e instituições bancárias associadas. - [Detalhar conta credora](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-accounts-id.md): Recupera informações detalhadas sobre uma conta credora específica através do seu identificador único. Retorna dados completos da conta incluindo informações do proprietário, detalhes da conta de pagamento e metadados associados. - [Deletar conta credora](https://developers.celcoin.com.br/reference/delete_open-keys-itp-api-v2-applications-applicationid-accounts-id.md): Remove permanentemente uma conta credora específica da aplicação. Esta ação não pode ser desfeita. A conta deve existir e pertencer à aplicação especificada antes de poder ser deletada. - [Adicionar URL de redirecionamento](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-redirects.md): Método para adicionar uma nova URL de redirecionamento para uma aplicação - [Listar URLs de redirecionamento](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-redirects.md): Método para listar URLs de redirecionamento para uma aplicação - [Obter URL de redirecionamento](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-redirects-id.md): Método para obter uma URL de redirecionamento específica para uma aplicação - [Excluir URL de redirecionamento](https://developers.celcoin.com.br/reference/delete_open-keys-itp-api-v2-applications-applicationid-redirects-id.md): Método para remover uma URL de redirecionamento de uma aplicação - [Criar webhook de aplicação](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-webhooks.md): Cria uma configuração de webhook para uma aplicação receber notificações sobre eventos de pagamento e mudanças de status de jornada. Suporta vários métodos de autenticação incluindo chave API, autenticação básica e token de portador. - [Listar webhooks da aplicação](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-webhooks.md): Método para listar todas as configurações de webhook de uma aplicação. - [Obter webhook da aplicação](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-webhooks-id.md): Método para obter os detalhes de um webhook específico da aplicação. - [Remover webhook da aplicação](https://developers.celcoin.com.br/reference/delete_open-keys-itp-api-v2-applications-applicationid-webhooks-id.md): Método para remover um webhook específico da aplicação. - [Criar ou atualizar configuração de aplicação](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-applications-applicationid-settings.md): Cria ou atualiza uma configuração de aplicação. As configurações podem incluir favicon, cor primária, alias de jornada, provedor de identidade e visibilidade do botão de inscrição. Isso permite personalizar a aparência e comportamento da aplicação. - [Listar configurações da aplicação](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-applications-applicationid-settings.md): Método para listar todas as configurações de uma aplicação incluindo favicon, cor primária, alias de jornada, provedor de identidade e visibilidade do botão de inscrição. - [Lista as detentoras participantes do ITP.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-participants-brands-1.md): Método para retornar a lista de detentoras participantes do ITP. O retorno é paginado e pode ser filtrado pelo nome da detentora. - [Obtém os detalhes de uma detentora participante do ITP.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-participants-brands-id-1.md): Método para retorno dos detalhes de uma detentora participante do ITP. - [Cria uma sessão de jornada ITP.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payments-v4-journeys-sessions-1.md): Método para a criação de uma sessão de uma jornada ITP. Para escolher a jornada, deve ser passado o id de uma jornada. Podem ser verificadas as jornadas disponíveis pelo endpoint `GET /open-keys/itp/api/v2/journeys`. - [Lista as sessões de uma jornada.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-journeys-sessions-1.md): Método para listar todas as sessões de uma jornada criadas por uma aplicação. Deve ser passado o id da jornada que deve ser listadas as sessões. - [Busca por uma sessão de uma jornada.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-journeys-sessions-id-1.md): Método que retorna uma sessão de uma jornada a partir do seu id. - [Cria uma sessão de jornada ITP para vínculo.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-1.md): Método para a criação de uma sessão de uma jornada ITP para fins de vínculo. Para escolher a jornada, deve ser passado o id de uma jornada. Podem ser verificadas as jornadas disponíveis pelo endpoint `GET /open-keys/itp/api/v2/journeys`. - [Lista as sessões de jornada de cadastro.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-1.md): Método para listar todas as sessões de jornada de cadastro criadas por uma aplicação. Deve ser passado o id da jornada que deve ser listadas as sessões. - [Busca por uma sessão de jornada de cadastro.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-id-1.md): Método que retorna uma sessão de jornada de cadastro a partir do seu id. - [Atualiza a sessão de jornada de vínculo.](https://developers.celcoin.com.br/reference/patch_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-id.md): Método para atualizar a sessão de jornada de vínculo. Nesse momento é possível atualizar apenas o status, sendo utilizado para o cancelamento da sessão. - [Busca por uma sessão de jornada de cadastro, usando como referência o id externo enviado na criação da sessão.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-external-externalid-1.md): Método que retorna uma sessão de jornada de cadastro a partir do seu id. O externalId é a propriedade passada na requisição de criação da sessão da jornada. - [Busca por uma sessão de jornada de cadastro com estágio.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-id-stage.md): Método que retorna uma sessão de jornada de cadastro a partir do seu id incluindo informações de estágio. - [Verificar se a sessão da jornada de cadastro expirou.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-journeys-sessions-id-verify-expired.md): Método para verificar se uma sessão da jornada de cadastro expirou. - [Criar vínculo (link de conta).](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiations.md): Este endpoint inicia o processo de vinculação de contas do Open Finance, criando um enrollment que permite iniciação de pagamentos sem redirecionamento para a detentora de contas. Esta é a primeira etapa do processo de duas fases: 1) Criar vínculo/link de conta com a detentora de conta, 2) Usar o vínculo estabelecido para realizar pagamentos. O processo de enrollment envolve autenticação do usuário, criação de consentimento e vinculação de credenciais (FIDO2) com a instituição detentora de conta. - [Listar vínculos de conta (enrollments).](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-payment-initiations.md): Lista os vínculos de conta do Open Finance (enrollments) existentes criados pelo usuário. Estas são as conexões estabelecidas com as instituições detentoras de contas que podem ser usadas para iniciação de pagamentos sem redirecionamento. Cada enrollment representa um vínculo seguro que passou pelo processo de autenticação e vinculação de credenciais FIDO2. - [Obtém uma iniciação de pagamento de cadastro.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id.md): Método para obter uma iniciação de pagamento de cadastro. - [Atualiza uma iniciação de pagamentos de vínculo.](https://developers.celcoin.com.br/reference/patch_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id.md): Método para atualizar uma iniciação de pagamentos de vínculo. - [Obtém a iniciação de pagamento de cadastro atualizada.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id-updated.md): Método para obter a iniciação de pagamento de cadastro atualizada. - [Obtém as opções de registro FIDO para cadastro.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id-fido-registration-options.md): Método para obter as opções de registro FIDO para cadastro. - [Completa o registro FIDO de cadastro.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id-fido-registration.md): Objeto que contém a resposta da criação de uma nova credencial FIDO2. - [Obtém as opções de assinatura FIDO para autenticação.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id-fido-sign-options.md): Método para obter as opções de assinatura FIDO para autenticação. - [Autoriza o consentimento de cadastro.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiations-id-authorise.md): Objeto que contém a resposta da criação de uma nova credencial FIDO2. - [Processamento de Pagamento.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payments-v4-payment-initiation.md): Método para Processamento de Pagamento. - [Processamento de Pagamento.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-payment-initiation.md): Método para Processamento de Pagamento. - [Processamento de Pagamento.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-payment-initiation-id.md): Método para Processamento de Pagamento. - [Processamento de Pagamento.](https://developers.celcoin.com.br/reference/patch_open-keys-itp-api-v2-payments-v4-payment-initiation-id.md): Método para Processamento de Pagamento. - [Processamento de Pagamento.](https://developers.celcoin.com.br/reference/patch_open-keys-itp-api-v2-payments-v4-payment-initiation-id-payments-paymentid.md): Método para Processamento de Pagamento. - [Criar sessão de gerenciamento de usuário final com URL.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payment-initiation-management-sessions.md): Método para criar uma sessão de gerenciamento de usuário final com URL. - [Obter dados da sessão de gerenciamento de usuário final.](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payment-initiation-management-sessions.md): Método para obter dados da sessão de gerenciamento de usuário final. - [List Open Finance Brasil participant institution brands](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-participants-brands.md): Retrieves a paginated and filterable list of financial institution brands participating in the Open Finance Brasil ecosystem. Returns detailed information about each institution including authorization server details, supported APIs, account type capabilities, and branding information. Supports advanced filtering by name, API family types, account support flags, and custom search criteria with accent-insensitive matching. - [Get Open Finance Brasil participant institution brand by ID](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-participants-brands-id.md): Retrieves detailed information about a specific financial institution brand participating in the Open Finance Brasil ecosystem. Returns comprehensive data including authorization server details, supported API capabilities, account type support flags, organization information, OpenID Connect configuration, and branding elements. This endpoint provides complete institutional metadata required for payment initiation and consent flows. - [Create Open Finance account enrollment for PIX payment initiation](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiation.md): Initiates the Open Finance Brasil account linking process (enrollment) that enables PIX payment initiation without user redirection to the account holder institution. This creates a secure, persistent connection between the payment initiator and the account holder through a comprehensive flow involving user authentication, risk signal collection, consent management, and FIDO2 credential binding. The process includes: 1) User identity verification with CPF/CNPJ, 2) Device risk signals collection for fraud prevention, 3) OAuth2 consent creation with the account holder, 4) FIDO2 biometric/PIN credential registration, 5) Account link authorization. Once established, this enrollment enables seamless PIX payments without repeated user authentication at the account holder. - [List account links (enrollments).](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-payment-initiation.md): Lists existing Open Finance account links (enrollments) created by the user. These are the established connections with account holder institutions (detentoras de contas) that can be used for payment initiation without redirection. Each enrollment represents a secured link that has gone through the authentication and FIDO2 credential binding process. - [Retrieve enrollment payment initiation details with brand and authorization information](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-enrollments-v2-payment-initiation-id.md): Retrieves comprehensive enrollment information for PIX payment initiation including brand details (ISPB, customer-friendly name, logos), Open Finance enrollment status, risk signals data, authorization metadata, and transaction limits. Used in JSR (Journey without Redirection) flows to provide complete enrollment context for payment processing. - [Get parameters for FIDO2 credential creation.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiation-itp-enrollment-id-fido-registration-options.md): Endpoint to obtain the required parameters for initiating the process of creating a new FIDO2 credential on the user's device during the account enrollment flow for Open Finance Brasil payment initiation. This method generates a unique challenge for each call and returns all parameters required by the W3C WebAuthn API for the credential registration process. The enrollment must be in AWAITING_ENROLLMENT status. The created FIDO2 credential will be used subsequently for strong authentication in payment operations, meeting the security requirements of the Open Finance Brasil ecosystem for Journey without Redirection (JSR). - [Associate FIDO2 credential to account enrollment.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiation-itp-enrollment-id-fido-registration.md): Endpoint to complete the registration of a FIDO2 credential by associating it to the account enrollment for Open Finance Brasil payment initiation. The enrollment must be in AWAITING_ENROLLMENT status. After successful registration, the enrollment transitions to AUTHORISED status. Failure to verify the FIDO2 credential causes enrollment rejection, as the same challenge cannot be reused for multiple registrations. This endpoint receives the response from the WebAuthn navigator.credentials.create() process executed on the user's device. - [Get parameters for FIDO2 authentication.](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiation-itp-enrollment-id-fido-sign-options.md): Endpoint to obtain the required parameters for FIDO2 authentication using previously registered credentials during Open Finance Brasil payment operations. This method generates a unique challenge for each call and returns parameters compatible with the WebAuthn navigator.credentials.get() API for verifying digital signatures. The enrollment must be in AUTHORISED status with valid associated FIDO2 credentials. Used in Journey without Redirection (JSR) for strong authentication before authorizing payment transactions. - [Authorizes enrollment consent using FIDO2 signature](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-enrollments-v2-payment-initiation-itp-enrollment-id-authorise.md): Completes the authorization process for an Open Finance Brasil payment initiation enrollment using FIDO2 authentication. This endpoint receives the digital signature generated by the user's FIDO2 authenticator, validates the signature against the previously issued challenge, and authorizes the payment consent. Includes device risk signals for security analysis and fraud prevention. - [Create PIX payment initiation](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payments-v4-payment-initiation-1.md): Creates a new PIX payment initiation according to Open Finance Brasil specification. Allows single or recurring payments through Central Bank of Brazil's PIX arrangement, including consent validation and transaction processing. - [List PIX payment initiations with filters](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-payment-initiation-1.md): Retrieves a paginated list of PIX payment initiations with support for filtering by status, date range, and scheduling type. Supports query parameters for advanced filtering and pagination according to Open Finance Brasil specifications. - [Get PIX payment initiation by ID](https://developers.celcoin.com.br/reference/get_open-keys-itp-api-v2-payments-v4-payment-initiation-id-1.md): Retrieves a specific PIX payment initiation by its unique identifier. Returns detailed payment information including status, amount, creditor data, and execution details according to Open Finance Brasil specifications. - [Decode PIX EMV string](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payments-v4-payment-initiation-pix-emv.md): Decodes a PIX EMV string to extract payment information such as receiver data, amount, city and additional information. Supports Central Bank of Brazil's EMV-QR Code standard for PIX instant payments. - [Execute PIX payment](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payments-v4-payment-initiation-id-pix.md): Executes a PIX instant payment for a previously created payment initiation. Supports different local instruments including DICT (PIX key), QRDN and QRES (QR codes). Requires FIDO authentication flow for transaction authorization according to Open Finance Brasil regulations. - [Process OAuth2 authorization callback from account holder](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payment-initiation-callback.md): Handles OAuth2 authorization callback responses from account holder institutions after user consent. Processes authorization codes, ID tokens, and state parameters to complete the consent flow for payment initiation (PAYMENTS_V4), automatic payments (AUTOMATIC_PAYMENTS_V2), or enrollment-based payments (ENROLLMENTS_V2). This endpoint is called by the account holder after the user authorizes or rejects the consent request. - [Create payment initiation management session](https://developers.celcoin.com.br/reference/post_open-keys-itp-api-v2-payment-initiation-management-session.md): Creates a secure management session for end users to access payment initiation interfaces. Generates an authenticated URL with opaque token that allows users to manage their payment initiations through a white-label interface. Supports both individual (CPF) and business entity (CNPJ) users with optional redirect URL configuration. - [Consulta de risco por CPF/CNPJ](https://developers.celcoin.com.br/reference/getassess-1.md): Consulta informações de risco para um CPF ou CNPJ informado no parâmetro `taxid`. - [New Endpoint](https://developers.celcoin.com.br/reference/get_new-endpoint.md): This is your first endpoint! Edit this page to start documenting your API. ## Recipes - [[cel_credit] Enviar arquivo assinado por outro Provedor](https://developers.celcoin.com.br/recipes/cel_credit-enviar-arquivo-assinado-por-outro-provedor.md) - [Criação de contas PF](https://developers.celcoin.com.br/recipes/criação-de-contas-pf.md) - [Criação de contas PJ](https://developers.celcoin.com.br/recipes/criação-de-contas-pj.md) - [DDA](https://developers.celcoin.com.br/recipes/dda.md) - [Débitos Veiculares - cel_payments](https://developers.celcoin.com.br/recipes/débitos-veiculares-cel_payments.md) - [Débitos Veiculares (Consulta Enriquecida) - cel_payments](https://developers.celcoin.com.br/recipes/débitos-veiculares-consulta-enriquecida-cel_payments.md) - [Pagamento de Contas - BaaS](https://developers.celcoin.com.br/recipes/pagamento-de-contas-baas.md) - [Pagamento de Contas (Ficha de Compensação/ Boletos e Guias de Convênios) - cel_payments](https://developers.celcoin.com.br/recipes/pagamento-de-contas-ficha-de-compensação-boletos-e-guias-de-convênios-avulso.md) - [Pagamento de débitos dependentes - cel_payments](https://developers.celcoin.com.br/recipes/pagamento-de-débitos-dependentes-cel_payments.md) - [Pagamento de débitos distintos - cel_payments](https://developers.celcoin.com.br/recipes/pagamento-de-débitos-distintos-cel_payments.md) - [Pagamento de débitos obrigatórios - cel_payments](https://developers.celcoin.com.br/recipes/pagamento-de-débitos-obrigatórios-cel_payments.md) - [Pagamento parcelado Débitos Veicualares - cel_payments](https://developers.celcoin.com.br/recipes/pagamento-parcelado-débitos-veicualares-cel_payments.md) - [TED - BaaS](https://developers.celcoin.com.br/recipes/pagamento-ted-baas.md) - [Transferência Pix a partir de uma chave - cel_payments](https://developers.celcoin.com.br/recipes/pix-avulso-transferência-pix-a-partir-de-uma-chave.md) - [Pix-out via QR Code Dinâmico - cel_payments](https://developers.celcoin.com.br/recipes/pix-out-via-qr-code-dinâmico-avulso.md) - [Pix-out via QR Code Estático - cel_payments](https://developers.celcoin.com.br/recipes/pix-out-via-qr-code-estático-avulso.md) - [Realizar o pagamento de um débito veicular](https://developers.celcoin.com.br/recipes/realizar-o-pagamento-de-um-débito-veicular.md) ## Pages - [Convênios Débito Automático](https://developers.celcoin.com.br/page/convênios-débito-automátio.md) - [Status Page](https://developers.celcoin.com.br/page/status-page.md) - [Teste -1 Piloto nova pagina](https://developers.celcoin.com.br/page/teste-1-piloto-nova-pagina.md)