Pular para o conteúdo principal

Criar Corban

Este serviço permite criar um novo Corban, com associações opcionais a configurações financeiras e promotores de crédito, dependendo das necessidades de pagamento direto ou gestão financeira do Corban.

Endpoint para Criar Corban​

  • Método: POST
  • URL: https://bff-dev.granatech.com.br/api/corban

Estrutura de Dados para Corban​

O objeto Corban inclui informações fundamentais para identificar e configurar o Corban no sistema. Abaixo estão os campos do objeto Corban, incluindo detalhes sobre campos opcionais que podem ser usados para integrar configurações financeiras e promotores de crédito.

Campos do Objeto Corban​

  • document (string, obrigatório): Documento CNPJ do Corban.
  • legalName (string, obrigatório): Nome legal do Corban.
  • businessName (string, obrigatório): Nome comercial do Corban.
  • automaticApproval (boolean, obrigatório): Define se a aprovação do Corban é automática.
  • financialSettingsId (string, opcional): ID das configurações financeiras associadas, caso seja necessário configurar pagamentos diretos para o Corban.
  • creditPromoterId (number, opcional): ID do promotor de crédito associado, se aplicável.

Processo de Criação​

Configurações Financeiras (opcional)​

Caso o Corban precise de configurações financeiras específicas, como a gestão de pagamento direto (pagamento em Y), essas configurações devem ser criadas e configuradas antes da criação do Corban. Para isso, utilize o endpoint para criar configurações financeiras. Esse processo gera um financialSettingsId que poderá ser incluído na criação do Corban.

Nota: Veja a documentação completa sobre como criar configurações financeiras para detalhes sobre os campos e o processo de criação.

Passo 1: (Opcional) Criar Configurações Financeiras​

Caso as configurações financeiras sejam necessárias, crie-as antes de criar o Corban e obtenha o financialSettingsId retornado. A documentação para a leitura de configurações financeiras também está disponível aqui, caso seja necessário validar ou verificar configurações antes de incluir no Corban.

Passo 2: Criar o Corban​

Após obter o financialSettingsId (caso aplicável), o próximo passo é criar o Corban, utilizando os dados essenciais e opcionais, conforme necessário.

Exemplo de Dados para Criação do Corban​

{
  "document": "12345678000100",
  "legalName": "Corban Legal",
  "businessName": "Corban Comercial",
  "automaticApproval": true,
  "financialSettingsId": "ID obtido de configurações financeiras",
  "creditPromoterId": 1
}

Exemplo de Requisição com curl para Criar Corban​

curl -X POST https://bff-dev.granatech.com.br/api/corban \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12345678000100",
    "legalName": "Corban Legal",
    "businessName": "Corban Comercial",
    "automaticApproval": true,
    "financialSettingsId": "ID obtido de configurações financeiras",
    "creditPromoterId": 1
  }'

Observações Importantes​

  1. Campos Opcionais: Tanto financialSettingsId quanto creditPromoterId são opcionais. Se não houver necessidade de configurações financeiras ou associação com promotores de crédito, esses campos podem ser omitidos.
  2. Ordem das Criações: Se financialSettingsId for necessário, garanta que as configurações financeiras sejam criadas antes de criar o Corban.
  3. Formato Numérico: Para campos numéricos, como sourceIncomeTax, use formatações adequadas, como parseFloat, para assegurar que os valores estejam corretamente formatados.

Seguindo esses passos e diretrizes, é possível configurar um Corban completo com os parâmetros necessários para operar de acordo com as políticas e integrações financeiras definidas.