Bem-vindo(a) à referência técnica da API de Emissão de Cédulas de Crédito Bancário (CCB), Cédulas do Produto Rural (CPR) e Notas Comerciais.
Esta API foi desenvolvida para facilitar e automatizar o processo de emissão desses documentos financeiros, proporcionando uma solução eficiente, segura e integrada para instituições financeiras, empresas e desenvolvedores que necessitam desse serviço.
Visão Geral
O recurso de Emissão de CCBs, CPRs e Notas Comerciais foi projetado para simplificar a criação, gerenciamento e emissão de crédito. Com uma interface RESTful, nossa API oferece endpoints que permitem a interação programática com os serviços de emissão, garantindo uma integração suave com os sistemas existentes das instituições financeiras e empresas.
Principais recursos
- Emissão de CCBs: Facilita a criação e emissão de Cédulas de Crédito Bancário, instrumento utilizado para formalizar operações de crédito entre instituições financeiras e seus clientes.
- Emissão de Notas Comerciais: Facilita a emissão de Notas Comerciais, utilizadas por empresas para formalizar operações de crédito entre empresas e investidores.
- Emissão de CPRs: Facilita a emissão de Cédulas do Produto Rural, operação utilizada para viabilizar e investir no setor de agronegócio.
- Simulação de operação de crédito: Simule as suas operações antes de qualquer emissão.
- Obtenha detalhes de suas operações de crédito: Através de nossa API, você poderá obter detalhes de suas operações de crédito, obter uma listagem das parcelas além de ter acesso a informações sobre valores e amortização.
- Submissão de operação via API: Crie e submeta operações de crédito de forma 100% dinâmica através de nossa API.
Status possíveis de uma emissáo de crédito
| Status | Descrição | Definido por |
|---|---|---|
| draft | A emissão de crédito é um rascunho. | Cliente |
| confirmed | A emissão de crédito foi confirmada. | Cliente |
| cancelled | A emissão de crédito foi cancelada. | Cliente |
| banker | A emissão de crédito está com o parceiro bancarizador. | Grafeno |
| analyze | A emissão de crédito está sendo analisada. | Grafeno |
| returned | A emissão de crédito foi devolvida. | Grafeno |
| refused | A emissão de crédito foi recusada. | Grafeno |
| signature | A emissão de crédito está na esteira de assinatura. | Grafeno |
| signed | A emissão de crédito foi assinada pelas partes. | Grafeno |
| assignment_process | A emissão de crédito está em processo de atribuição | Grafeno |
| escriturado | A emissão de crédito foi escriturada. | Grafeno |
| disbursed | A emissão de crédito foi desembolsada. | Grafeno |
| settled | A emissão de crédito foi concluída. | Grafeno |
| admin_analysis | A emissão de crédito está em análise pela Grafeno. | Cliente |
| bookkeeper_analysis | A emissão de crédito está em análise pelo Escriturador. | Grafeno |
Parâmetros de retorno
| Parâmetro | Descrição | Tipo |
|---|---|---|
| id | Id da operação de crédito. | Integer |
| type | Tipo de operação de crédito. | String |
| status | Status da operação de crédito. | String |
| draft_step | String | |
| value | Valor da operação de crédito. | String |
| installments_quantity | Quantidade de parcelas. | String |
| first_installment_date | Data da primeira parcela. | String |
| tax_percentage | Tarifa de operação em valor percentual. | String |
| emission_tax | Tarifa de emissão em valor percentual. | String |
| indication | Indicador de juros. | String |
| indexer | Indexador de juros | String |
| amortization_table | Tabela de amortização. | String |
| amortization_rule | Reagra de amortização. | String |
| waiting_period | Período de carência. | String |
| simulation.liquid_value | Valor líquido. | String |
| simulation.monthly_fee | Tarifa mensal. | String |
| simulation.contract_date | Data do contrato de operação de crédito. | String |
| simulation.iof | Imposto sobre Operações financeiras (IOF). | String |
| simulation.daily_iof | Imposto sobre Operações financeiras (IOF) diário. | String |
| simulation.total_iof | Imposto sobre Operações financeiras (IOF) total. | String |
| simulation.emission_cost | Custo de emissão | String |
| simulation.cost | Custo Total. | String |
| simulation.emission_tax | Tarifa de emissão. | String |
| simulation.tax_percentage | Taxa em valor percentual. | String |
| simulation.commission_cost | Custo da comissão. | String |
| simulation.commission_tax | Taxa de comissão. | String |
| simulation.gross_value | Valor bruto. | String |
| simulation.buffered_loan_value | Valor do empréstimo. | String |
| simulation.total_fee | Tarifas totais. | String |
| simulation.cet | Custo Efetivo Total (CET). | String |
| simulation.annual_tir | Taxa Interna de Retorno (TIR) anual. | String |
| simulation.monthly_tir | Taxa Interna de Retorno (TIR) mensal. | String |
| simulation.cost_tax | Tarifas totais. | String |
| simulation.installment_value | Valor da parcela. | String |
| simulation.installments_quantity | Total de parcelas. | String |
| simulation.installments.number | Número da parcela. | String |
| simulation.installments.due_date | Data de vencimento da parcela. | String |
| simulation.installments.day | Dia referente a parcela. | String |
| simulation.installments.total_value | Valor total da parcela. | String |
| simulation.installments.amortization | Valor total para amortização. | String |
| simulation.installments.interest_value | Valor total dos juros. | String |
| simulation.installments.edited_value | Total de parcelas quando houve edição do parcelamento. | String |
| simulation.installments.edited_due_date | Data de vencimento da parcela que editada. | String |
| simulation.installments.remaining_balance | Saldo remanescente. | String |
| simulation.installments.daily_iof | Imposto sobre Operações financeiras (IOF) diário. | String |
| simulation.installments.daily.reference | Data de referência diária. | String |
| simulation.installments.daily.amortization | Valor total para amortização diária. | String |
| simulation.installments.daily.installment_number | Número da parcela. | String |
| simulation.installments.daily.interest | Valor diário dos juros. | String |
| simulation.installments.daily.remainingBalance | Saldo remanescente diário. | String |
| simulation.difference | Diferença. | String |
| simulation.payments_frequency | Frequência de pagamentos. | String |
| simulation.credit_taxes.type | Tipo de tarifa de crédito. | String |
| simulation.credit_taxes.original_amount | Valor original sem tarifa. | String |
| simulation.credit_taxes.tax | Valor da tarifa. | String |
| simulation.creditor_id | Id do credor. | Integer |
| simulation.installment_amount | Valor da parcela. | String |
| simulation.calculate_mode | Tipo de cálculo. | String |
| simulation.nextInstallment.number | Número da próxima parcela. | String |
| simulation.nextInstallment.due_date | Data de vencimento da próxima parcela. | String |
| simulation.nextInstallment.day | Dia referente a próxima parcela. | String |
| simulation.nextInstallment.total_value | Valor total da próxima parcela. | String |
| simulation.nextInstallment.amortization | Valor para amortização da próxima parcela. | String |
| simulation.nextInstallment.interest_value | Valor dos juros da próxima parcela. | String |
| simulation.nextInstallment.edited_value | Próxima parcela das parcelas que foram editadas. | String |
| simulation.nextInstallment.edited_due_date | Data de vencimento da próxima parcela editada. | String |
| simulation.nextInstallment.remaining_balance | Saldo remanescente referente a próxima parcela. | String |
| simulation.nextInstallment.daily_iof | Imposto sobre Operações financeiras (IOF) diário referente a próxima parcela. | String |
| simulation.nextInstallment.daily.reference | Data de referência diária da próxima parcela. | String |
| simulation.nextInstallment.daily.amortization | Valor total para amortização diária da próxima parcela. | String |
| simulation.nextInstallment.daily.installment_number | Número da próxima parcela. | String |
| simulation.nextInstallment.daily.interest | Juros diários da próxima parcela. | String |
| simulation.nextInstallment.daily.remainingBalance | Saldo remanescente diário referente a próxima parcela. | String |
| partner_id | Id do parceiro. | Integer |
| optional_ensure | Garantia opcional para a operação de crédito. | String |
| external_ensure | Indica se a operação de crédito teve ou não uma garantia. | String |
| reject_reason | Motivo do cancelamento da operação. | String |
| reject_observation | Observação sobre o cancelamento da operação. | String |
| Debtor object | Objeto que recebe os dados do devedor. Vide estrutura. | String |
| creditor_id | Id do credor. | Integer |
| consultant_id | Id do consultor. | Integer |
| creditor.id | Id do credor. | Integer |
| creditor.name | Razão Social do credor. | String |
| creditor.identifier | CNPJ do credor. | String |
| creditor.originator_code | Código de originação do credor. | String |
| partner | Parceiro. | String |
| document_number_cnab | Número do arquivo CNAB da operação. | String |
| created_at | Data de criação da operação de crédito. | Date (YYYY-MM-DD) |
| updated_at | Data de atualização da operação de crédito. | Date (YYYY-MM-DD) |
| ccb_number | Número da CCB. | Integer |
| draft_contracts.id | Id do contrato em rascunho. | Integer |
| draft_contracts.credit_id | Id da operação de crédito. | Integer |
| draft_contracts.minute_id | Id da minuta de crédito. | Integer |
| draft_contracts.category_id | Categoria da minuta de crédito. | Integer |
| draft_contracts.status | Status da operação de crédito. | String |
| draft_contracts.created_at | Data de criação da operação de crédito. | Date (YYYY-MM-DD) |
| draft_contracts.updated_at | Data da última atualização da operação de crédito. | Date (YYYY-MM-DD) |
| draft_contracts.deleted_at | Data de exclusão da operação de crédito. | Date (YYYY-MM-DD) |
| late_payment_tax | Tarifa de pagamento feito em atraso. | String |
| fine_rate | Tarifa de multa. | String |
| type_of_calculation | Tipo de calculo de multa. | String |
| person_type | Tipo de entidade jurídica que obteve o crédito (PF pu PJ). | String |
Webhooks
A API do Grafeno ativos ainda não oferece suporte para webhooks. Portanto, todas as operações e atualizações de estado precisam ser verificadas ativamente por meio de chamadas aos endpoints da API. No futuro, planeamos incluir suporte para webhooks, permitindo que notificações em tempo real sejam enviadas aos clientes conforme eventos importantes ocorram, como a conclusão de emissões ou o desembolso de valores.