Referência API
Postman CollectionStatus PageReferência APIGrafeno Digital

Simulações

Simulação de operações de NC e CCB.

Antes de se tornarem operações de crédito, as operações de CCB e Nota Comercial (NC) precisam ser simuladas. A simulação calcula os valores da operação (parcelas, taxas, cronograma etc.) a partir dos parâmetros informados.

Existem dois cenários de uso, controlados pelo parâmetro save_as_draft:

  • Simulação apenas para consulta de valores → save_as_draft=false. Os valores são calculados e retornados, mas nada é persistido na plataforma.
  • Simulação que virará uma operação → save_as_draft=true. A simulação é salva como rascunho na plataforma e poderá evoluir para uma operação de crédito.

📘

Informação

O save_as_draft é enviado como query parameter na URL, e não no corpo da requisição.

Endpoints

O tipo de operação a simular é definido no caminho do endpoint:

POST /laas/v2/simulation/ccb   # CCB
POST /laas/v2/simulation/nc    # Nota Comercial
AmbienteBase URL
Staginghttps://apis.stg.grafeno.be
Produçãohttps://apis.grafeno.digital

Exemplo de URL completa (simulação de CCB salva como rascunho):

https://apis.stg.grafeno.be/laas/v2/simulation/ccb?save_as_draft=true

Query parameters

ParâmetroTipoDescrição
save_as_draftbooleanfalse para simular apenas os valores; true para salvar a simulação como rascunho de operação.

Parâmetros de cálculo (corpo da requisição)

Os parâmetros abaixo são enviados no corpo (JSON) da requisição e definem como a operação será calculada.

ParâmetroTipoDescrição
person_typestringTipo de pessoa do devedor. Ex.: legal_person (PJ), natural_person (PF).
contract_datestring (ISO 8601)Data do contrato da operação.
partner_idstring (uuid)UUID do parceiro (escriturador para NC, bancarizador para CCB), obtido no endpoint de parceiros.
valuenumberValor da operação.
installments_quantityintegerQuantidade de parcelas.
amortization_rulestringRegra de contagem de dias usada no cálculo. Ex.: 252-business-days (dias úteis).
payments_frequencystringPeriodicidade dos pagamentos. Ex.: monthly.
first_installment_datestring (ISO 8601)Data de vencimento da primeira parcela.
indicationstringNatureza da taxa. Ex.: pre-fixed (pré-fixada) ou pós-fixada.
amortization_tablestringSistema de amortização. Ex.: price, sac.
tax_percentagenumberPercentual da taxa de juros aplicada.
waiting_periodintegerPeríodo de carência.
indexerstringIndexador da operação (para taxas pós-fixadas). Ex.: cdi.
installment_amountnumberValor da parcela.
percentual_comissionnumberPercentual de comissão que o credor receberá encima da operação.
type_of_calculationstringBase de cálculo da operação. Ex.: net_value (valor líquido).
include_daily_databooleanSe true, inclui o detalhamento diário das parcelas no resultado da simulação.

Exemplo de requisição

curl --request POST \
     --url 'https://apis.stg.grafeno.be/laas/v2/simulation/ccb?save_as_draft=true' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'Authorization: Bearer {access_token}' \
     --data '{
       "person_type": "legal_person",
       "contract_date": "2026-05-05T18:16:00.000Z",
       "partner_id": "{uuid_do_parceiro}",
       "value": 888000,
       "installments_quantity": 10,
       "amortization_rule": "252-business-days",
       "payments_frequency": "monthly",
       "first_installment_date": "2026-05-12T18:16:00.000Z",
       "indication": "pre-fixed",
       "amortization_table": "price",
       "tax_percentage": 0.5,
       "waiting_period": 2,
       "indexer": "cdi",
       "installment_amount": 1000,
       "percentual_comission": 1,
       "type_of_calculation": "net_value",
       "include_daily_data": true
     }'

Resultado via webhook

O processamento da simulação é assíncrono. O resultado não é retornado no corpo da resposta da requisição, ele é entregue posteriormente via webhook.

Certifique-se de ter um endpoint de webhook configurado para receber o retorno com os valores calculados da simulação.

Payload de notificação de simulação

{
  "id": "0acffc55-4bd1-464b-95c4-3b84c4b356a8",
  "data": {
    "cet": 0.9608,
    "iof": 0,
    "cost": 3449.61,
    "cost_tax": 0,
    "credit_id": "44c3659e-6e76-42b6-b6e6-57e214cfc675",
    "daily_iof": 0,
    "total_fee": 29622.03,
    "total_iof": 0,
    "annual_tir": 0.1215,
    "difference": 0,
    "method_tac": "percentage",
    "creditor_id": "9e23cddb-4557-493b-958e-9001c2b9b22b",
    "gross_value": 907790.83,
    "monthly_fee": 0.005,
    "monthly_tir": 0.9608,
    "credit_taxes": [
      {
        "tax": 0,
        "type": "commission",
        "original_amount": 16340.23
      },
      {
        "tax": 0,
        "type": "partner",
        "original_amount": 0
      },
      {
        "tax": 0,
        "type": "grafeno",
        "original_amount": 3449.61
      },
      {
        "tax": 0,
        "type": "emission_partner_cost",
        "original_amount": 3449.61
      }
    ],
    "emission_tax": 0.38,
    "installments": [
      {
        "day": 7,
        "daily": [],
        "number": 1,
        "due_date": "2026-08-12T00:00:00.000Z",
        "total_value": 4538.95,
        "amortization": 0,
        "edited_value": false,
        "interest_value": 4538.95,
        "edited_due_date": false,
        "remaining_balance": 907790.83
      },
      {
        "day": 38,
        "daily": [],
        "number": 2,
        "due_date": "2026-09-12T00:00:00.000Z",
        "total_value": 4538.95,
        "amortization": 0,
        "edited_value": false,
        "interest_value": 4538.95,
        "edited_due_date": false,
        "remaining_balance": 907790.83
      },
      {
        "day": 68,
        "daily": [],
        "number": 3,
        "due_date": "2026-10-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 111502.92,
        "edited_value": false,
        "interest_value": 4538.95,
        "edited_due_date": false,
        "remaining_balance": 796287.91
      },
      {
        "day": 99,
        "daily": [],
        "number": 4,
        "due_date": "2026-11-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 112060.43,
        "edited_value": false,
        "interest_value": 3981.44,
        "edited_due_date": false,
        "remaining_balance": 684227.48
      },
      {
        "day": 129,
        "daily": [],
        "number": 5,
        "due_date": "2026-12-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 112620.73,
        "edited_value": false,
        "interest_value": 3421.14,
        "edited_due_date": false,
        "remaining_balance": 571606.75
      },
      {
        "day": 160,
        "daily": [],
        "number": 6,
        "due_date": "2027-01-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 113183.84,
        "edited_value": false,
        "interest_value": 2858.03,
        "edited_due_date": false,
        "remaining_balance": 458422.91
      },
      {
        "day": 191,
        "daily": [],
        "number": 7,
        "due_date": "2027-02-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 113749.76,
        "edited_value": false,
        "interest_value": 2292.11,
        "edited_due_date": false,
        "remaining_balance": 344673.15
      },
      {
        "day": 219,
        "daily": [],
        "number": 8,
        "due_date": "2027-03-12T00:00:00.000Z",
        "total_value": 116041.88,
        "amortization": 114318.51,
        "edited_value": false,
        "interest_value": 1723.37,
        "edited_due_date": false,
        "remaining_balance": 230354.64
      },
      {
        "day": 250,
        "daily": [],
        "number": 9,
        "due_date": "2027-04-12T00:00:00.000Z",
        "total_value": 116041.87,
        "amortization": 114890.1,
        "edited_value": false,
        "interest_value": 1151.77,
        "edited_due_date": false,
        "remaining_balance": 115464.54
      },
      {
        "day": 280,
        "daily": [],
        "number": 10,
        "due_date": "2027-05-12T00:00:00.000Z",
        "total_value": 116041.86,
        "amortization": 115464.54,
        "edited_value": false,
        "interest_value": 577.32,
        "edited_due_date": false,
        "remaining_balance": 0
      }
    ],
    "liquid_value": 888000.99,
    "contract_date": "2026-08-05T18:16:00.000Z",
    "emission_cost": 19789.84,
    "calculate_mode": "tax",
    "commission_tax": 1.8,
    "tax_percentage": 0.5,
    "commission_cost": 16340.23,
    "installment_value": 116041.88,
    "installment_amount": 0,
    "payments_frequency": "monthly",
    "buffered_loan_value": 907790.83,
    "installments_quantity": 10
  },
  "event": "simulation-created.success",
  "created": "2026-07-09T20:19:34.379Z",
  "api_version": "v2",
  "metadata": {
    "livemode": false,
    "idempotency_key": "e0be1b49-d0e1-4ed0-9d03-851d3c88db82"
  }
}

Updated about 7 hours ago

Updated about 7 hours ago