Pular para o conteúdo principal

Consultar Configurações Financeiras (Financial Settings)

Este serviço permite consultar as configurações financeiras associadas a um Corban específico, usando o ID das Configurações Financeiras. A consulta é fundamental para verificar ou revisar os detalhes financeiros, incluindo dados bancários e parâmetros de gestão de comissão.

Endpoint para Consultar Configurações Financeiras​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/financial-settings/{financialSettingsId}

Parâmetro de URL​

  • financialSettingsId (string, obrigatório): O ID das Configurações Financeiras que se deseja consultar.

Exemplo de Requisição com curl​

curl -X GET https://bff-dev.granatech.com.br/api/financial-settings/12345

Exemplo de Resposta​

A resposta traz o objeto completo de FinancialSettings, contendo informações como o e-mail para comissão, gestores comerciais, e dados bancários.

{
  "id": "12345",
  "commissionEmail": "comissao@empresa.com",
  "commercialManager": "João Silva",
  "externalCommercialManager": "Maria Oliveira",
  "bankAccount": "987654321",
  "agency": "1234",
  "accountDigit": "1",
  "sourceIncomeTax": 0.15,
  "kaminoId": "67890",
  "bluepayId": "12345",
  "bank": "Banco Bradesco S.A."
}

Observações​

  1. Verificação de Dados Financeiros: Este endpoint é útil para verificar as configurações financeiras antes de realizar operações relacionadas ao Corban, garantindo que as informações de pagamento e gestão estejam corretas.
  2. Configuração Prévia Necessária: Caso as configurações financeiras ainda não tenham sido criadas para o Corban, consulte a documentação de criação de Configurações Financeiras para configurar antes de realizar a consulta.

Com este endpoint, é possível revisar e confirmar as informações financeiras necessárias para o processamento correto dos pagamentos.