Visão Geral

As custom_variables são campos personalizados configurados pela Celcoin durante a implantação do produto. Elas permitem armazenar informações específicas do negócio junto à operação e podem ser utilizadas para compor o template da CCB.

O originador não cadastra variáveis. Esse processo é realizado pelo time de implantação da Celcoin. O originador apenas informa os valores no payload da criação da application.

Para saber quais variáveis estão disponíveis no seu produto, consulte o time de implantação da Celcoin ou utilize o endpoint de consulta abaixo.

Consultar Variáveis do Produto

GET /banking/originator/products/{product_id}/variables

Authorization: Bearer {originator_access_token}

Como Utilizar

O originador informa os valores no campo custom_variables.values na criação da CCB. Todos os valores devem ser enviados como string, independente do tipo configurado.

{
  "product": { "id": "PRODUCT_ID" },
  "borrower": { "id": "BORROWER_ID" },
  "funding": { "id": "FUNDING_ID" },
  "custom_variables": {
    "values": {
      "nome_da_variavel": "valor"
    }
  }
}

Quando não há variáveis a passar, envie o objeto vazio:

{
  "custom_variables": {
    "values": {}
  }
}

Atenção: Nunca omita o campo custom_variables se o produto possuir variáveis obrigatórias. Valores ausentes ou fora do padrão configurado podem causar erro na criação da CCB.

Exemplos por Produto

Crédito Pessoal

Variáveis livres definidas pelo originador junto à Celcoin na configuração do produto.

{
  "custom_variables": {
    "values": {
      "payment_day": "10",
      "store_code": "LOJA-SP-042",
      "campaign_id": "BLACK-FRIDAY-2025"
    }
  }
}

Portabilidade

As variáveis são obrigatórias neste produto. Representam os dados do contrato de origem e compõem a CCB emitida.

{
  "custom_variables": {
    "values": {
      "original_contract_ispb": "341",
      "original_contract_ispb_name": "Banco Itaú S.A.",
      "original_contract_last_due_balance": "8750.50",
      "original_contract_monthly_interest_rate": "0.0189",
      "original_contract_total_installments_count": "36",
      "original_contract_installment_amount": "485.20"
    }
  }
}

Variável	Descrição
`original_contract_ispb`	Código ISPB do banco de origem
`original_contract_ispb_name`	Nome do banco de origem
`original_contract_last_due_balance`	Saldo devedor atualizado do contrato original em R$
`original_contract_monthly_interest_rate`	Taxa de juros mensal do contrato original. Ex: `0.0189` → 1,89% a.m.
`original_contract_total_installments_count`	Quantidade total de parcelas do contrato original
`original_contract_installment_amount`	Valor da parcela do contrato original em R$

Crédito do Trabalhador (Consignado Privado)

Variáveis de vínculo empregatício e configuração do convênio.

{
  "custom_variables": {
    "values": {
      "employer_registration_code": "677671959",
      "cost_center": "RH-001",
      "agreement_code": "3b9be0e7-3af9-4ca4-ad31-26233a58486a"
    }
  }
}

CDC (Crédito Direto ao Consumidor)

Variáveis do bem financiado.

{
  "custom_variables": {
    "values": {
      "asset_description": "Notebook Dell Inspiron 15",
      "asset_serial_number": "SN-20241105-XYZ",
      "asset_value": "4500.00",
      "seller_code": "PARCEIRO-0091"
    }
  }
}