Jump to Content
Home
API Reference
Changelog
Comunidade
Área do Desenvolvedor
Status
v1.5
Log In
API Reference
Log In
v2.0
Home
API Reference
Changelog
Comunidade
Área do Desenvolvedor
Status
Utilidades para fluxo de Onboarding
All
Pages
Start typing to search…
JUMP TO
APIs Banking
Cartões de crédito e faturas
Listar cartões
get
Faturas de cartão de crédito
Listar faturas de cartão de crédito
get
Visualizar detalhes da fatura do cartão de crédito
get
Visualizar transações da fatura do cartão de crédito
get
Cobranças
Pix Automático - Agendamentos
Listar Cobranças Agendadas para Pix Automático
get
Criar Agendamento de Cobrança para Pix Automático
post
Cancelar um Agendamento de Cobrança para Pix Automático
del
Pix Automático - Autorizações
Listar Autorizações de Pix Automático
get
Criar Autorização de Pix Automático
post
Cancelar Autorização de Pix Automático
del
Modificar Autorização de Pix Automático
patch
Cobranças
Buscar cobrança
get
Cancelar Cobrança
del
Atualizar Cobrança
put
Criar Cobranças em lote
post
Listar cobranças
get
Criar Cobrança
post
Negativação de boletos
Enviar negativação em lote
post
Enviar cancelamento de negativação em lote
del
Link de pagamento
Criar link de pagamento
post
Listar links de pagamentos
get
Atualizar link de pagamento
put
Cancelar link de pagamento
del
Listar cobranças de um link de pagamento
get
Pix cobrança dinâmico
Obter lista de QR Codes
get
Criar QR Code
post
Desvincular QR Code da cobrança.
del
Obter lista de cobraças
get
Criar cobrança
post
Pix automático
Listar Autorizações de Pix Automático
get
Saldo, Extrato e Open Finance
Guia de conciliação
Conta PJ e Open Finance
GET pdf base64
get
Consultar saldo
get
Consultar dados da conta
get
Consultar extrato por accountId
get
Consultar extratos
get
Pagamentos
Pagamentos Recorrentes
Resumo de recorrências de pagamento
get
Listar pagamentos de recorrência
get
Alterar recorrência de pagamento
patch
Cancelar recorrência de pagamento
del
Consultar recorrência de pagamento
get
Listar recorrências
get
Criar recorrência de pagamento
post
Gestão de lote de pagamento
Abandonar Lote
del
Abrir Lote
post
Processar Lote
patch
Listar iniciação de pagamento ou transferência
get
Criar iniciação de pagamento ou transferência
post
Listar um pagamento ou transferência específico
get
Cancelar um pagamento ou transferência agendado
del
Consulta por código de barras
get
Obter recibo
get
Débito Direto Autorizado
Ativar DDA para o usuário
post
Desativar DDA para o usuário
del
Consultar DDAs
get
Modificar DDA
patch
Consultar resumo de débitos
get
Criar nova configuração
post
Apagar configuração
del
Crédito
Antecipação de cartão de crédito
Visualiza contas de desembolso
get
Consulta de operações
get
Consulta de valores para antecipar
get
Antecipação de recebíveis
post
Resumo do saldo devedor
get
Busca recebíveis por parâmetros de busca
post
Listagem de recebíveis
get
API de webhooks
Webhook
Alterar a secret de um webhook
post
Listar o webhook especificado
get
Criar um webhook
post
API de Leads de Crédito
Leads de crédito
Envio das informações para solicitação de crédito
post
API de cambio
Cambio
Consulta das moedas disponíveis
get
Consulta da cotação indicativa da moeda e do tipo de fluxo
post
Onboarding enrichment
Utilidades para fluxo de Onboarding
Obter lista de profissões
get
Obter a lista de estados e cidades
get
Enrichment
Obter informações básicas da empresa cliente no parceiro
get
Obter o endereço informações da empresa cliente no parceiro
get
Obter os representantes legais da empresa cliente no parceiro
get
Obter documentos da empresa cliente no parceiro
get
Obter os a lista de documentos existentes da empresa cliente para download no parceiro
get
Supply Chain Finance
Onboarding de consignado
Onboarding de fornecedores
Registro de entidades
post
Risco Sacado e Cessão com coobrigação
Operation
Criar operação
post
Consultar uma operação cadastrada
get
Settlement
Criar pedido de liquidação de recebiveis
post
Consultar um pedido de liquidação cadastrado
get
Bordero
Criar um bordero
post
Consultar recebíveis de um bordero
get
Cancelar recebíveis
post
Company
Cadastrar fornecedores
post
Consultar status de um fornecedor
get
Receivables
Anexar arquivos
put
Trade
Consultar carteira de operações
get
Consultar a posição de um trade especifico
get
Sacado-Simples
Cadastro simplificado de pagador
post
Solar
Análise de crédito
Gerar uma análise de crédito
post
Verificar se uma determinada empresa está apta a operar o fluxo solar
get
Workflow
Aceite da proposta
post
Envio do comprovante de instalação
post
Envio dos dados iniciais
post
Envio dos documentos
post
Envio dos documentos pendênciados
post
Api para consultar documentos enviados
get
Download da proposta indicativa de Solar
post
Envia proposta indicativa por e-mail
post
Carta autorização de faturamento dos equipamentos
post
Download do comprovante de desembolso
post
Envio das notas fiscais pendênciadas
post
Envio das notas fiscais
post
FIDC
Renegotiation
Consultar o(s) contrato(s) passivéis de renegociação agrupados por elegibilidade
get
Consultar as campanhas de renegociação ativas para o(s) contrato(s)
get
Simular um acordo de renegociação para o(s) contrato(s)
post
Confirmar um acordo de renegociação para uma simulação criada
post
Cancelar o acordo de renegociação antes do pagamento da parcela de boa fé
del
Consultar o boleto por parcela de um acordo de renegociação
get
Prepayment
Consultar posição do crédito por contrato
get
Simular uma solicitação de pré pagamento
post
Confirmar uma simulação de pré pagamento
post
Consultar o boleto de pré pagamento
get
Simulation
Simular o crédito antes da operação usando configurações do convênio.
post
Document
Upload de arquivos auxiliares para a operação de crédito
post
Eligibility
Realizar a pré elegibilidade
post
Operation
Criar uma operação
post
Wallet
Consultar uma carteira de um fundo especifico
get
Consultar carteira de algum contrato ou contraparte especifica
get
Warranty
Criar uma garantia
post
Payment
Criar um pedido de pagamento de crédito
post
Consultar um pedido de pagamento cadastrado
get
Credit Conciliation
Criar um novo pedido de repasse de pagamentos em lote
post
Consultar o status de um pedido de repasse de pagamentos em lote
get
Portabilidade Out
Realizar uma portabilidade out
post
Confirmação de portabilidade out
post
Cancelamento de um pedido de portabilidade
post
Fluxo de consignado privado
Averbação
Envio do Arquivo de Averbação
post
Escrituração
Envio do Arquivo de Escrituração
post
Desligamento
Envio do arquivo de Desligamento dos funcionários
post
Motor de crédito
Motor de crédito
Envio da base de clientes para análise de pré-aprovação
post
Obtenção do retorno da análise de pré-aprovação da base de clientes
get
Análise detalhada por cliente específico.
post
Outras APIs
Arquivos
Criar link para upload de arquivo
post
Powered by
Utilidades para fluxo de Onboarding
Ask AI
