Getting Started

🚧

API em fase beta

A API Grafeno Ativos está em fase beta e, neste momento, apenas clientes selecionados têm acesso ao ambiente de testes.

Tem interesse em testar? Clique aqui, selecione o formulário "Integração via API - Levantamento Técnico" e solicite seu acesso.

Visão geral

A Grafeno Ativos é a nossa API de emissão de operações de crédito clean. Por meio dela, você emite crédito utilizando dois instrumentos:

• CCB - Cédula de Crédito Bancário
• NC - Nota Comercial

O termo clean indica que estas operações não possuem suporte a garantias. Ou seja, a emissão é feita com base no risco de crédito do tomador, sem vinculação de colaterais (garantias reais ou fidejussórias) à operação.

O que você pode fazer

Com a API Grafeno Ativos, você tem à disposição todo o fluxo necessário para estruturar e emitir uma operação de crédito, do início ao fim:

• Simular operações de NC e CCB, obtendo as condições da operação antes de efetivá-la.
• Cadastrar devedores (tomadores de crédito) que farão parte das operações.
• Listar parceiros bancarizadores e escrituradores disponíveis para a estruturação da operação.
• Listar as minutas de operação associadas à sua conta.
• Criar operações de crédito, efetivando a emissão a partir das informações previamente cadastradas.

Arquitetura baseada em webhooks

A API Grafeno Ativos é totalmente baseada em webhooks. Isso significa que as operações de simulação e de criação de operação funcionam de forma assíncrona: a chamada à API é apenas o gatilho, e o resultado é entregue posteriormente por meio de um webhook.

Na prática:

• Ao simular uma operação, o resultado da simulação é retornado via webhook.
• Ao criar uma operação, a confirmação da operação também é retornada via webhook.

⚠️

Tratamento de erros também é assíncrono

Mesmo em caso de erro, a exceção é retornada via webhook, e não na resposta síncrona da requisição. Por isso, é fundamental que sua integração esteja preparada para receber e tratar os eventos de webhook, tanto para os casos de sucesso quanto para os de falha.

Antes de começar, certifique-se de ter um endpoint de webhook configurado em sua conta no Grafeno Ativos e acessível para receber os eventos enviados pela API.

Fluxo básico de integração

O caminho recomendado para uma primeira integração segue estes passos:

1. Configure o webhook onde você deseja receber os eventos da API.
2. Consulte os parceiros bancarizadores e escrituradores disponíveis.
3. Cadastre o devedor (tomador de crédito) da operação. Recomendamos enviar os documentos do tomador antes de realizar o cadastro.
4. Simule a operação (NC ou CCB) e aguarde o resultado da simulação via webhook.
5. Consulte as minutas de operação disponíveis de acordo com o tipo de emissão (CCB ou NC).
6. Crie a operação de crédito e aguarde a confirmação via webhook.

Precisa de suporte ou ficou com alguma dúvida sobre a API? Abra um chamado em [email protected] e o nosso time vai te ajudar rapidinho.