Jump to Content
Documentação
Recipes
API
Ask AI
v2.0.0
v2.0.1
Status Page
Suporte
API
Search
Status Page
Suporte
v2.0.0
Documentação
Recipes
API
Ask AI
Automatic Payments v1 - Payment Initiation
All
Pages
Start typing to search…
JUMP TO
Celcoin Infratech API
Token
Gera o token para autenticação dos endpoints da API.
post
CEL_ONBOARDING
Onboarding
Criar proposta Pessoa Física.
post
Criar proposta Pessoa Jurídica.
post
Buscar uma proposta ou uma lista de propostas.
get
Busca um arquivo ou uma lista de arquivos.
get
Busca tagueamento da jornada do webview.
get
cel_banking - BaaS
Gestão de Contas
Criação de contas
Abertura de conta e KYC
Verificar Status da Conta.
get
Atualizar dados do Cliente PF
put
Atualizar dados do Cliente PJ
put
Retorna informações de conta PF
get
Retorna informações de conta PJ
get
Retorna informações de varias contas PF
get
Retorna informações de varias contas PJ
get
Altera status da conta
put
Encerra conta
del
Criação de contas V1 (Descontinuado)
Criar Conta PJ
post
Criar Conta PF
post
Informação das Contas
Consultar Saldo
get
Consultar Saldo do Dia
get
Consultar Extrato
get
Consultar Transações do Extrato
get
Consultar Extrato Detalhado (Beta)
get
Transferência entre contas
Inicia uma transferência entre contas
post
Consultar status de uma transferência interna
get
Pix
Pagamento (cash-out)
Consulta EMV QRCode
Consultar uma chave Pix (DICT)
get
Pix Cashout
post
Verificar Status do PIX
get
Participantes PIX
get
Recebimento (cash-in)
Criação de QRCode
Consulta status de QRCode
Consulta de recebimentos Pix
Devolução de cash-in
Iniciar a Devolução de um Recebimento Pix
post
Consultar o Status de uma Devolução de Recebimento Pix
get
Devolução de cash-out
Consultar uma devolução de Pix-out
Gerenciamento de Chaves
Criar chaves Pix
post
Consultar chaves Pix de uma conta
get
Excluir chaves Pix
del
Portabilidade e Reivindicação de Chaves Pix
Cadastra nova reivindicação/portabilidade de chave Pix
post
Confirma nova reivindicação/portabilidade de chave Pix
post
Cancela nova reivindicação/portabilidade de chave Pix
post
Consulta reivindicação/portabilidade de chave Pix
get
Consulta lista de reivindicação/portabilidade de chave Pix
get
Split Pix
Split de Pix Cash-in por QR Code dinâmico(duedate)
post
Split de Pix Cash-in por QR Code dinâmico (immediate)
post
Pix Automático
Jornada Pagadora
Aceita uma recorrência Jornada 1
patch
Aceita uma recorrência jornada 2
post
Aceita uma recorrência Jornada 3
post
Aceita uma recorrência jornada 4
post
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
post
Jornada Recebedora
Crie uma recorrência com jornada 1
post
Crie uma recorrência com a jornada 2
post
Crie uma recorrência jornada 3
post
Crie uma recorrência jornada 4
post
Envio de agendamento
put
Retentativas de recebimento
post
Cancelamento de agendamento
post
Cancelamento da recorrência
post
Pix Inteligente
Criar consentimento para transação de Pix Inteligente
post
Cancelar consetimento de longo prazo
patch
Detalhar Consentimento
get
Listar consentimentos
get
Agendador de Transação
Consultar agendamento de pix
get
Cancelar agendamento de pix
del
Endpoint responsável por listar agendamentos
get
TED
Enviar uma TED
post
Consultar Status de uma transferência TED
get
Emissão de boletos
Emitir Boleto
post
Consultar Boleto Emitido
get
Consulta de Boletos por Período (BETA)
get
Cancelar Boleto Emitido
del
Gerar PDF para um Boleto Emitido
get
CNAB
Processamento de Arquivo CNAB
post
Consulta de Dados CNAB enviado
get
Baixar arquivo retorno do CNAB pelo id.
get
Baixar arquivo remessa do CNAB pelo id.
get
Pagamento de Contas
Pagamento de conta.
post
Status de um Pagamento de conta.
get
Recargas
Realizar Recarga
post
Consultar Recarga
get
Débitos Veiculares
Criar pedido de consulta de débitos veiculares.
post
Consultar pedido de consulta de débitos veiculares.
get
Realizar pagamento de Débito Veicular
post
Consultar pagamento e débitos veiculares.
get
Informe de Rendimentos
Consultar Informe de Rendimentos
get
Subadquirência (Acquiring as a Service)
Credenciar Conta BaaS na Sub Celcoin
post
Criar Cobrança
post
Listar Cobranças
get
Editar Cobrança
put
Retentar Cobrança
put
Estornar Cobrança no Cartão
put
Cancelar Cobrança Avulsa
del
Cadastrar Webhook Chargeback
put
Enviar Documentação Chargeback
put
Desistir da Disputa do Chargeback
put
Listar Chargebacks
get
Criar Cliente
post
Listar Clientes
get
Editar Cliente
put
Excluir Cliente
del
Criar Cartão
post
Listar Cartões
get
Inativar Cartão
del
Criar Plano
post
Listar Planos
get
Editar Plano
put
Excluir Plano
del
Criar Assinatura (ou Contrato) Manual
post
Criar Assinatura (ou Contrato) com Plano pré-definido
post
Adicionar uma transação
post
Listar Assinaturas (ou Contratos)
get
Gerenciamento de Webhook
Cadastrar Webhook
post
Consultar Webhooks cadastrados
get
Editar Webhook cadastrado
put
Excluir Webhook cadastrado
del
Consultar lista de eventos enviados pelo webhook
get
Consultar Templates de Webhooks
get
Consultar quantidade de webhooks enviados.
get
Consultar detalhes dos webhooks enviados.
get
Reenvio de webhooks pendentes
put
Dados via Open Finance
Consentimento
Pedido de consentimento de dados
post
Callback do consentimento
post
Accounts | Dados
Obtém a lista de contas consentidas pelo cliente
get
Obter detalhes de uma conta específica
get
Obtém os saldos da conta identificada por accountId
get
Obtém a lista de transações da conta identificada por accountId
get
Customers | Dados
Obtém os registros de identificação da pessoa natural
get
Obtém os dados de qualificação da pessoa natural
get
Obtém os dados de relacionamento da pessoa natural com a instituição
get
Obtém os registros de identificação da pessoa jurídica
get
Obtém os dados de qualificação da pessoa jurídica
get
Obtém os dados de relacionamento da pessoa jurídica com a instituição
get
Resources | Dados
Obtém a lista de recursos consentidos pelo cliente
get
Investments | Dados
Obtém lista de investimentos em renda fixa bancária
get
Obtém detalhes de um investimento em renda fixa bancária
get
Obtém saldos de um investimento em renda fixa bancária
get
Obtém transações de um investimento em renda fixa bancária
get
Obtém lista de investimentos em renda fixa de crédito
get
Obtém detalhes de um investimento em renda fixa de crédito
get
Obtém lista de investimentos em renda variável
get
Obtém detalhes de uma nota de corretagem
get
Obtém lista de investimentos em títulos do tesouro
get
Obtém lista de investimentos em fundos
get
Financings | Dados
Obtém os dados dos contratos de financiamento
get
Obtém detalhes de um contrato de financiamento identificado por contractId
get
Obtém cronograma de parcelas de um financiamento
get
Obtém histórico de pagamentos de um financiamento
get
Obtém a lista de garantias vinculadas ao contrato de financiamento
get
Loans | Dados
Obtém lista de contratos de empréstimo
get
Obtém detalhes de um contrato de empréstimo
get
Obtém cronograma de parcelas de um empréstimo
get
Obtém histórico de pagamentos de um empréstimo
get
Obtém garantias de um contrato de empréstimo
get
Pagamentos via Open Finance (ITP)
Contas de crédito da Aplicação
Criar conta de crédito
post
Listar contas de crédito
get
Buscar dados de uma conta de crédito
get
Deletar uma conta de crédito
del
URL de redirecionamentos da Aplicação
Adicionar URL de redirecionamento
post
Listar URLs de redirecionamento
get
Buscar dados de uma URL de redirecionamento
get
Deletar URL de redirecionamento
del
Webhooks da Aplicação
Cadastrar webhook da aplicação
post
Obter .
get
Obter .
get
Obter .
del
Configuração da Aplicação
Criar ou atualizar configuração da aplicação
post
Obtain .
get
Participants
Lista as detentoras participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Sessão de jornadas
Criar uma sessão de jornada ITP
post
Listar sessões de jornada
get
Buscar dados de uma sessão de jornada
get
Enrollment Journey Sessions
Creates an ITP journey session for enrollment.
post
Lists enrollment journey sessions.
get
Search for an enrollment journey session.
get
Updates the enrollment journey session.
patch
Search for an enrollment journey session, using as reference the external ID sent in the creation of the session.
get
Enrollment Payment Initiation
Creates an enrollment payment initiation.
post
Lists enrollment payment initiations.
get
Gets an enrollment payment initiation.
get
Updates an enrollment payment initiation.
patch
Gets enrollment FIDO registration options.
post
Completes enrollment FIDO registration.
post
Gets enrollment FIDO sign options.
post
Authorizes enrollment consent.
post
Payment Initiation
Payment Processing.
post
Payment Processing.
get
Payment Initiation Management Session
Create end user managament session with url.
post
Get end user management session data.
get
cel_credit - Originador (Arquivado)
Autenticação
EMBEDDED PAYMENT
APIs auxiliares
Retornar informações do seu saldo atual
get
Recuperar detalhes de uma transação
get
Obter comprovante de uma transação
get
Listar convênios
get
Retorna a saúde de um determinado tipo de transação
get
Listar bancos
get
Listar transações pendentes
get
APIs de Extrato
Consultar extrato consolidado
get
Arquivos de Conciliação
Buscar tipos de arquivos
get
Extrair arquivo
get
Extrato consolidado
get
DDA
Webhooks
Configurar webhooks
post
Consultar webhooks
get
Usuários
Cadastrar usuário
post
Excluir usuário
del
Boletos (Apenas sandbox)
Gerar boleto
post
Débitos Veiculares
Consulta
Consultar Débitos de um veículo
post
Enriquecimento de Placas
Consultar Dados Enriquecidos de um Veículo
post
Pagamento
Realizar pagamento
post
Webhook
Registrar URL para recebimento de notificações via Webhook
post
Registrar Webhook Com Token - JWT
post
Retornar URL registrada para recebimento de notificações via Webhook
get
Emissão de Boletos
Gestão de Carteiras
Inclusão de Carteira
post
Consulta de Carteira por código/ID
get
Alteração de Carteira
patch
Exclusão de carteira
del
Consulta de todas as Carteiras
get
Gestão de Beneficiários
Inclusão de Beneficiário
post
Consulta de Beneficiário
get
Gestão de Boletos
Emissão de Boleto
post
Consulta de boletos com paginação
get
Consulta de boleto por Id
get
Gestão de Baixas
Inclusão de Baixa (Cancelamento)
post
Consulta de Baixa
get
Pagamento de contas
Consultar os dados de uma conta
post
Reservar saldo para efetuar o pagamento de uma conta
post
Confirmar o pagamento de uma conta
put
Consultar status de uma transação
get
Consultar ocorrências de um pagamento
get
Cancelar uma reserva realizada
del
Reverter uma transação de pagamento de contas efetuada
del
Pagamentos - Obter comprovante de uma transação
get
Pix Automático
Jornada Pagadora
Aceita uma recorrência
post
Aceita uma recorrência
patch
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
get
Jornada Recebedora
Crie uma recorrência com a jornada 1
post
Crie uma recorrência com a jornada 2
post
Pix-in
Cobrança dinâmica (dynamic)
Criar um QR Code dinâmico
post
Buscar dados de uma cobrança dinâmica
get
Atualizar QR Code dinâmico
put
Recupera uma imagem base64 representando um QR Code dinâmico
get
Carrega, valida e parseia o json do payload da URL
post
Deletar um QR Code dinâmico
del
Cobrança estática
Criar um QR Code estático
post
Retornar dados de um QR Code estático.
get
Recupera uma imagem base64 representando um QR Code estático
get
Retornar dados do QR Code estático e os pagamentos recebidos
get
Deleta um QR code estático
del
QR Code (Location)
Criar um QR Code (location)
post
Retorna os dados de um QR Code location
get
Recupera uma imagem base64 representando um QR Code Location dinâmico
get
Cobrança imediata (COB)
Criar nova cobrança imediata
post
Atualizar dados de uma cobrança imediata
put
Busca de dados de uma cobrança imediata
get
Desvincular cobrança imediata de um BRCode Location
patch
Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)
get
Deletar uma cobrança imediata
del
Cobrança com vencimento (COBV)
Criar cobrança com vencimento
post
Atualizar dados de uma cobrança com vencimento
put
Buscar dados de uma cobrança com vencimento
get
Desvincular cobrança com vencimento de um QR Code location
patch
Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)
get
Deletar uma cobrança com vencimento
del
Recebimentos Pix
Consulta o status de um Recebimento Pix
get
Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)
get
Devolução de cash-in
Criar uma devolução de um recebimento Pix via TransactionId
post
Consulta o status de uma devolução de recebimento Pix criada
get
Pix-out
DICT (Diretório de Identificadores de Contas Transacionais)
Retornar informações do DICT utilizando uma chave cadastrada no Pix
post
Realizar busca das estatísticas de chave ou de pessoa
get
Participante
Listar participantes do Pix
get
Pagamento com Pix
Iniciar pagamento Pix
post
Verificar o status de um pagamento Pix
get
Verificar o status de um pagamento Pix - Versão Enriquecida (V2)
get
Retornar informações de um QRCode pelo EMV
post
Devolução de cash-out
Consulta uma devolução de pagamento Pix recebida
get
ITP (Iniciação de Transação de Pagamento)
Criar um Pix ITP
post
Criar Setup de um Pix ITP
post
Editar Setup de um Pix ITP
put
Recargas
Listar operadoras
get
Consultar valores operacionais para uma operadora ou provedor
get
Reservar saldo para realizar recarga
post
Confirmar a transação de uma recarga
put
Consultar informações de uma recarga
get
Cancelar transação de recarga efetuada
del
Buscar operadora a partir de um número de telefone
get
Recargas - Obter comprovante de uma transação
get
Saques e depósitos físicos
Retornar lista de Parceiros
get
Consultar pontos de atendimentos próximos
post
Realizar depósito em um caixa 24h
post
Efetuar saque eletrônico com Qrcode
post
Gerar token para saque no caixa 24h
post
Cancela um token para saque no caixa 24h
del
TED
Realizar TED
post
Verificar status de uma TED
get
Cadastro de Webhooks
CEL_BRICKS WEBHOOKS
Webhook Manager
Cadastrar Webhook
post
Reenvio de webhooks pendentes
put
Consultar detalhes dos webhooks enviados.
get
Consultar quantidade de webhooks enviados.
get
Excluir Webhook cadastrado.
del
Editar Webhook cadastrado.
put
Consultar Webhooks cadastrados.
get
Participante Indireto Pix
Pix Automático
Jornada Pagadora
Aceita uma recorrência
post
Aceita uma recorrência
patch
Recusa uma recorrência
patch
Busca recorrências por status com paginação
get
Busca uma recorrência pelo ID
get
Cancelamento de Autorização
post
Cancelamento de agendamento
get
Jornada Recebedora
Crie uma recorrência com a jornada 1
post
Crie uma recorrência com a jornada 2
post
Recebimento com Pix
Consulta o status de um Recebimento Pix
get
Consulta o status de um Recebimento Pix -Versão Enriquecida (V2)
get
Pagamento com Pix
Gerar endToEndId para iniciar um pagamento
post
Iniciar pagamento Pix
post
Verificar o status de um pagamento Pix
get
Verificar o status de um pagamento Pix - Versão Enriquecida (V2)
get
Retornar informações do QR Code a partir de um EMV
post
Devolução
Criar devolução (estorno) de um Pix recebido
post
Criar devolução via endToEndId
post
Consulta o status de uma devolução Pix
get
Consulta o status do recebimento de uma Devolução
get
DICT (Diretório de Identificadores de Contas Transacionais)
Cadastro, Consulta e Deleção de chaves
Cadastrar uma nova chave Pix
post
Altera uma chave Pix
put
Retornar informações do DICT utilizando uma chave cadastrada no Pix
post
Verifica a existência de chaves no DICT
post
Deleta uma chave Pix
del
Realizar busca das estatísticas de chave ou de pessoa
get
Listar todas as chaves pix de um cliente
post
Portabilidade e Reivindicação
Cadastra nova portabilidade ou reivindicação DICT
post
Completa a solicitação de portabilidade/reivindicação de uma chave DICT
post
Cancela uma Claim em processo de resolução ou confirmada por expiração
post
Confirma uma Claim em processo de resolução
post
Consulta uma reivindicação existente
get
Lista portabilidades ou reivindicações com paginação
get
Infractions
Criar um relato de infração para uma transação
post
Consultar um relato de Infração para uma transação
get
Cancelar um relato de infração para uma transação
post
Fechar um relato de infração de uma transação
post
Lista infrações para participantes Indiretos
get
Mecanismo Especial de Devolução - MED
Criar solicitação de devolução
post
Consulta a solicitação de uma devolução
get
Cancelar solicitação de devolução
post
Fechar solicitação de devolução
post
Lista solicitações de devolução
get
Marcação de fraude
Cancela marcação de fraude
del
Cria marcação de fraude
post
Consulta detalhes da marcação de fraude
get
QR Code
Criar um QR Code (location)
post
Retorna os dados de um QR Code location
get
Deleta um QR code estático
del
Recupera uma imagem base64 representando um QR Code Location dinâmico
get
Cobrança com vencimento (COBV)
Criar cobrança com vencimento
post
Atualizar dados de uma cobrança com vencimento
put
Deletar uma cobrança com vencimento
del
Buscar dados de uma cobrança com vencimento
get
Desvincular cobrança com vencimento de um QR Code location
patch
Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)
get
Cobrança imediata (COB)
Criar nova cobrança imediata
post
Atualizar dados de uma cobrança imediata
put
Deletar uma cobrança imediata
del
Busca de dados de uma cobrança imediata
get
Desvincular cobrança imediata de um BRCode Location
patch
Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)
get
Cobrança dinâmica (dynamic)
Criar um QR Code dinâmico
post
Recupera uma imagem base64 representando um QR Code dinâmico
get
Atualizar QR Code dinâmico
put
Deletar um QR Code dinâmico
del
Carrega, valida e parseia o json do payload da URL
post
Cobrança estática
Criar um QR Code estático
post
Retornar dados de um QR Code estático.
get
Recupera uma imagem base64 representando um QR Code estático
get
Retornar dados do QR Code estático e os pagamentos recebidos
get
Transferência
Transações fora do SPI - Reporte Bacen
post
MED 2.0
Criar recuperação de valores
post
Consulta recuperação de valores
get
Cancelar recuperação de valores
post
Solicitar devolução de recuperação de valores
post
Consulta grafo de recuperação de valores
get
Atualiza recuperação de valores
put
CEL_CARD
Faturas
Busca as transações de uma fatura.
get
Listar faturas da conta.
get
Relatório de Autorizações
Obtem detalhes de autorizações
get
Autorização de Transações
Simula uma transação
post
Executa um chargeback
post
Gestão de Cartões
Busca dados de um cartão
get
Cria cartões de crédito/débito
Lista cartões
Atualiza dados de um Cartão
Ativa um cartão
Bloqueia um cartão
Desbloqueia um cartão
Cancela um cartão
Reemite um cartão
Efetua a alteração do pin do cartão
Busca a senha atual do cartão do cliente
Busca informações do cartão do cliente
Reseta tentativas erradas de senha
Reseta o contador de transações do aplicativo (ATC)
post
Gestão de Clientes
Lista todos os clientes de uma conta específica.
get
Obtém um cliente de uma conta específica pelo Documento.
get
Obtém um cliente de uma conta específica pelo ID.
get
Atualiza os dados de um cliente (PF ou PJ)
patch
Gestão de Contas
Busca dados de uma conta específica.
get
Busca uma conta pelos parâmetros.
get
Cria uma nova conta
post
Consulta os limites de uma conta específica
get
Atualiza limite de uma conta
patch
Passa conta informada para status cancelada.
post
Passa conta de status cancelada para normal.
post
Atualiza a data de vencimento da fatura
put
Gestão de Endereços
Cria um novo endereço para uma conta específica
post
Busca um único endereço de uma conta específica.
get
Atualiza os dados de um endereço
patch
Lista todos os endereços de uma conta específica.
get
Gestão de Telefone
Cria um novo telefone para uma conta específica
post
Busca de telefones cadastrado pela conta
get
Atualiza um telefone
get
Atualiza um telefone
patch
Embossing
Busca informações de embossing de um cartão
Simulação de rastreamento de um cartão
Atualiza endereço do embossing de um cartão
Reenvia cartão para embossing
CEL_CASH - AaaS
Autenticação
Gerar token de autenticação
post
Gestão de Contas
Cadastrar uma conta PF
post
Cadastrar uma conta PJ
post
Gestão de Recebíveis
Solicitar relatório de recebíveis
post
Visualizar recebível de transação
get
Visualizar recebível de contrato
get
Relatórios
Buscar estado de relatório solicitado
get
Visualizar arquivo de relatório
get
Webhooks
Visualizar template de evento de webhook
get
cel_credit
Visão Geral
Glossário de Termos Técnicos
Autenticação
Obter Token de Autenticação
post
Webhook
Listar Webhooks
get
Pessoas
Cadastros
Campos Cadastrais
Cadastrar Pessoa
post
Consultar Pessoas Cadastradas
get
Consultar Pessoa por ID
get
Atualizar Cadastro de Pessoa
put
KYC
Consultar KYC de CPF
get
Consultar de Forma Antecipada KYC de CPF
post
Enviar KYC Externo
post
Documentos
Cadastrar Documento de Pessoa
post
Consultar Documentos de Pessoa
get
Fazer Download de Documento de Pessoa
get
Atualizar Documento de Pessoa
put
Excluir Documento de Pessoa
del
Importações em Lote
Importar Pessoas em Lote
post
Consultar Importações em Lote de Pessoas
get
Consultar Status de Importação
get
Fazer Download de Resultado de Importação em Lote
get
Empresas
Cadastros
Cadastrar Empresa
post
Listar Empresas
get
Consultar Empresa por ID
get
Atualizar Empresa
put
Campos Cadastrais
Responsáveis Legais de Empresa
KYC
Consultar KYC por CNPJ
get
Consultar de Forma Antecipada KYC de CNPJ
post
Enviar KYC Externo
post
Relacionamentos Pessoa x Empresa
Criar Relacionamento Pessoa x Empresa
post
Consultar Relacionamentos de Empresa
get
Atualizar Relacionamento Pessoa x Empresa
put
Remover Relacionamento Pessoa x Empresa
del
Documentos
Cadastrar Documento de Empresa
post
Consultar Documentos de Empresa
get
Fazer Download de Documento de Empresa
get
Atualizar Documento de Empresa
put
Excluir Documento de Empresa
del
Contas Beneficiárias
Listar Contas Beneficiárias
get
Emissão de crédito
Simulações de Crédito
Criar Simulação por Valor Desejado
post
Criar Simulação por Valor Total Financiado
post
Criar Simulação por Valor Total das Parcelas
post
Criar Simulação com Juros Pós-Fixados
post
Solicitações de Crédito
Status de Solicitação
Campos de Solicitação
Erros de Geração de Boleto
Criar Solicitação
post
Criar Solicitação com Juros Pós-Fixados
post
Consultar Solicitação
get
Listar Solicitações
get
Cancelar Solicitação
post
Listar Índices Financeiros
get
Qualificações, Condições e Linhas de Crédito
Originadores, Financiadores e Emissores
Campos Linha de Crédito (Conditions)
Variáveis Personalizadas
Aprovar Qualification ID
put
Consultar Qualification ID
get
Assinaturas
Modalidades de Assinaturas
Clicksign
UNICO
ZapSign
Consultar Assinaturas de Solicitação
get
Consultar Configurações de Assinatura
get
Configurar Assinatura
post
Enviar Assinatura de Solicitação (Timestamp)
post
Enviar Assinatura Física de Solicitação (Assinatura Externa)
post
Contratos
Consultar Contrato de Solicitação
get
Consultar Contrato Assinado de Solicitação
get
Consultar os Documentos de Lastros
get
Ordem de Pagamento
Atualizar Ordem de Pagamento de Solicitação
put
Configurações de Desembolso
Desembolso Gerenciado
Múltiplas Datas de Desembolso
Controle de Desembolsos
Iniciar Tentativa de Desembolso
post
Consultar Tentativa de Desembolso
get
Listar Tentativas de Desembolso de Solicitação
get
Fazer Download de Comprovante de Desembolso
get
Emissão de Crédito consignado
Crédito do trabalhador - Sem leilão
Modalidade sem Leilão
Consignado Crédito Trabalhador
Modalidade com Leilão Interno
Leilão Interno - Solicitação de Proposta & Distribuição aos Originadores
Leilão Interno - Envio de Oferta, Leilão Interno & Devolutiva
Leilão Interno - Cadastro de Tomador, Emissão & Cancelamento
Leilão Interno - Erros de Averbação – Integração Dataprev
Sem Leilão - Solicitação & Consentimento de Tomador
Sem Leilão - Consulta de Margem & Simulação de Crédito
Sem Leilão - Cadastro de Tomador, Emissão & Cancelamento
Sem Leilão - Guia Rápido de Consignado
Status de Operação
Consultas, Escriturações e Repasses
Modalidade sem Leilão
Consignado Servidores do Exército
Autenticação
Consulta de Margem
Simulação de CCB
Cadastro de Tomador
Cadastro de Tomador & Solicitação
Compra com Troco
Status de Operação
Cessão de crédito
PAINEL DO CLIENTE
Tickets
Listagem de Tickets
get
Emissão de Nota Fiscal de Serviço
Gestão de Empresas
Cadastrar uma Empresa
post
Consultar uma Empresa
get
Cadastrar um Certificado Digital para a Empresa
post
Gestão de Nota Fiscal
Emitir Nota Fiscal de Serviço
post
Consultar Nota Fiscal de Serviço
get
Cancelar emissão de Nota Fiscal de Serviço
post
Celcoin - Escrow
Autenticação
Obter token de autenticação
post
Introdução
Pessoas
Upload de Documentos da Pessoa
post
Criar uma pessoa do tipo "física"
post
Listar as pessoas cadastradas
get
Criar uma pessoa do tipo "jurídica"
post
Atualizar cadastro da pessoa
patch
Contas
Criar uma nova conta
post
Listas todas as contas cadastradas
get
Consultar os detalhes de uma conta escrow
get
Consultar o extrato da conta
get
Consultar o status/detalhamento de uma transação
get
Consultar o saldo da conta
get
Contas > Retenção
Cadastrar uma retenção
post
Listar todas as retenções cadastradas
get
Alterar uma retenção
patch
Excluir uma retenção
del
Solicitações
Criar uma solicitação
post
Listar todas as solicitações
get
Consultar os detalhes de uma solicitação realizada
get
Revisar uma solicitação
put
Cancelar uma solicitação
put
Consultar os detalhes de um código de barras de um boleto
get
Contas > Webhook
Listar todas as entidades de webhooks disponíveis para configuração
get
Criar uma configuração de webhook
post
Listar todos os webhooks cadastrados para uma Conta
get
Alterar uma configuração de webhook
patch
Excluir uma configuração de webhook
del
Contas > Conta destino
Criar uma nova conta de destino (transferências)
get
Excluir uma conta de destino
del
Alterar uma conta de destino
patch
Carteiras
Cadastrar uma nova carteira
post
Listar todas as carteiras
get
Consultar os detalhes de uma carteira
get
Alterar os dados de uma carteira
patch
Arquivar ou desarquivar uma carteira
put
Carteiras > Cobranças
Cadastrar Cobrança
post
Listar todas as cobranças de uma carteira
get
Consultar os detalhes de uma cobrança
get
Excluir uma cobrança
del
Baixar o PDF de uma cobrança
get
Cadastrar uma nova cobrança (PIX)
post
Consultar uma cobrança (PIX)
get
OPEN KEYS (ITP Stand-alone)
Verificação de Saúde
Obter o status do serviço.
get
Gerenciamento de Aplicação
Criar aplicação
post
Listar aplicações
get
Obter detalhes da aplicação
get
Atualizar aplicação
put
Criar sessão de jornada de pagamento
post
Criar sessão de gestão do usuário final
post
Contas da Aplicação
Criar conta credora
post
Listar contas credoras
get
Detalhar conta credora
get
Deletar conta credora
del
Redirecionamentos da Aplicação
Adicionar URL de redirecionamento
post
Listar URLs de redirecionamento
get
Obter URL de redirecionamento
get
Excluir URL de redirecionamento
del
Webhooks da Aplicação
Criar webhook de aplicação
post
Listar webhooks da aplicação
get
Obter webhook da aplicação
get
Remover webhook da aplicação
del
Configurações da Aplicação
Criar ou atualizar configuração de aplicação
post
Listar configurações da aplicação
get
Participantes
Lista as detentoras participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Sessões de Jornada
Cria uma sessão de jornada ITP.
post
Lista as sessões de uma jornada.
get
Busca por uma sessão de uma jornada.
get
Sessões de Jornada JSR (Jornada sem Redirecionamento)
Cria uma sessão de jornada ITP para vínculo.
post
Lista as sessões de jornada de cadastro.
get
Busca por uma sessão de jornada de cadastro.
get
Atualiza a sessão de jornada de vínculo.
patch
Busca por uma sessão de jornada de cadastro, usando como referência o id externo enviado na criação da sessão.
get
Busca por uma sessão de jornada de cadastro com estágio.
get
Verificar se a sessão da jornada de cadastro expirou.
get
Iniciação de Pagamentos JSR (Jornada sem Redirecionamento)
Criar vínculo (link de conta).
post
Listar vínculos de conta (enrollments).
get
Obtém uma iniciação de pagamento de cadastro.
get
Atualiza uma iniciação de pagamentos de vínculo.
patch
Obtém a iniciação de pagamento de cadastro atualizada.
get
Obtém as opções de registro FIDO para cadastro.
post
Completa o registro FIDO de cadastro.
post
Obtém as opções de assinatura FIDO para autenticação.
post
Autoriza o consentimento de cadastro.
post
Iniciação de Pagamento
Processamento de Pagamento.
post
Processamento de Pagamento.
get
Processamento de Pagamento.
get
Processamento de Pagamento.
patch
Processamento de Pagamento.
patch
Sessão de Gerenciamento de Iniciação de Pagamento
Criar sessão de gerenciamento de usuário final com URL.
post
Obter dados da sessão de gerenciamento de usuário final.
get
CEL_OPEN (ITP Stand-alone EN)
Participants
List Open Finance Brasil participant institution brands
get
Get Open Finance Brasil participant institution brand by ID
get
JSR Payment Initiation (Journey without Redirection)
Create Open Finance account enrollment for PIX payment initiation
post
List account links (enrollments).
get
Retrieve enrollment payment initiation details with brand and authorization information
get
Get parameters for FIDO2 credential creation.
post
Associate FIDO2 credential to account enrollment.
post
Get parameters for FIDO2 authentication.
post
Authorizes enrollment consent using FIDO2 signature
post
Payment Initiation
Create PIX payment initiation
post
List PIX payment initiations with filters
get
Get PIX payment initiation by ID
get
Decode PIX EMV string
post
Execute PIX payment
post
Process OAuth2 authorization callback from account holder
post
Payment Initiation Management Session
Create payment initiation management session
post
Cartoes-Fatura-Management-Webservice
fees
Listar as taxas da fatura
get
Antecipacao
Cria uma antecipação de parcela
post
Simula a antecipação de parcelas para a fatura atual
get
Lista todas as antecipações de parcelas para a conta
get
Detalhe uma antecipação de parcela feita
get
Cancela uma antecipação de parcela
del
Powered by
Automatic Payments v1 - Payment Initiation
Ask AI
