put
https://sandbox.auth.flowfinance.com.br/banking/originator/business/
Atualiza integralmente as informações cadastrais de uma Empresa já existente na Plataforma, vinculada a um Originador.
Os dados enviados na requisição substituem completamente os valores atualmente armazenados para a Empresa informada.
Este endpoint permite atualizar, entre outros:
-
Informações cadastrais e fiscais
-
Dados de contato
-
Endereço principal e endereço de cobrança
-
Dados bancários
-
Chave PIX
-
Configurações operacionais
Descrição
Este endpoint permite atualizar os dados de uma Empresa específica, identificada pelo business_id.
A operação é exclusiva de atualização (PUT) e sobrescreve integralmente os dados existentes com as informações enviadas no corpo da requisição.
Método HTTP
PUT
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/business/{business_id}
Path Parameters
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| business_id | string (UUID) | Sim | Identificador único da Empresa cujos dados serão atualizados. |
Headers
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | string | Sim | Token de autenticação no formato Bearer {token}. |
| Content-Type | string | Sim | Deve ser informado como application/json. |
Body Parameters
Dados Principais da Empresa
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | string (UUID) | Sim | Identificador único do cadastro da Empresa. |
| taxpayer_id | string | Sim | CNPJ da Empresa (somente números). |
| legal_name | string | Sim | Razão social registrada na Receita Federal. |
| name | string | Sim | Nome fantasia da Empresa. |
| email_address | string | Sim | E-mail de contato da Empresa. |
| foundation_date | string | Sim | Data de abertura da Empresa (YYYY-MM-DD). |
| incorporation_type | string | Sim | Natureza jurídica da Empresa (ex.: LTDA, SA). |
| tax_regime | string | Sim | Regime tributário da Empresa. |
| industry_classification | string | Sim | Código CNAE da atividade principal. |
| share_capital | number | Sim | Capital social da Empresa. |
| monthly_revenue | number | Sim | Faturamento mensal estimado. |
| employer | boolean | Sim | Indica se permite cadastro de colaboradores. |
| custom_variables | object | Não | Variáveis personalizadas no formato chave-valor. |
Phone (Objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| country_code | string | Sim | Código do país (DDI). |
| area_code | string | Sim | Código da área (DDD). |
| number | string | Sim | Número do telefone (somente números). |
| formatted_number | string | Sim | Número formatado com DDI e DDD. |
Address (Objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| street_name | string | Sim | Nome do logradouro. |
| street_number | integer | Sim | Número do endereço. |
| district | string | Sim | Bairro. |
| city | string | Sim | Cidade. |
| state_code | string | Sim | Sigla do estado (UF). |
| postal_code | string | Sim | CEP. |
| country_code | string | Sim | Código do país (ISO-3). |
| extra_info | string | Não | Complemento do endereço. |
Billing Address (Objeto)
Objeto com a mesma estrutura de Address, utilizado para os dados de cobrança da Empresa.
Pix (Objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| key | string | Sim | Chave PIX cadastrada para a Empresa. |
| key_type | string | Sim | Tipo da chave PIX (ex.: TAXPAYER_ID, EMAIL). |
External Bank Account (Objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| bank_code | string | Sim | Código do banco. |
| bank_branch | string | Sim | Número da agência bancária. |
| bank_account | string | Sim | Número da conta bancária. |
| bank_account_digit | string | Sim | Dígito verificador da conta. |
| bank_account_type | string | Não | Tipo da conta bancária. |
| ispb_code | string | Sim | Código ISPB da instituição financeira. |
Exemplo de Requisição
PUT /banking/originator/business/008e1751-4d6c-438f-a928-c03ad48c30aa
Authorization: Bearer {token}
Content-Type: application/json
{
"id": "008e1751-4d6c-438f-a928-c03ad48c30aa",
"legal_name": "Alpha Soluções Digitais LTDA",
"taxpayer_id": "84406315000123",
"name": "Alpha Soluções",
"email_address": "[email protected]",
"foundation_date": "2012-03-25",
"incorporation_type": "LTDA",
"tax_regime": "REAL_PROFIT",
"industry_classification": "6201501",
"share_capital": 250000,
"monthly_revenue": 45000,
"employer": false
}
Resposta de Sucesso
Status: 200 OK
Indica que os dados da Empresa foram atualizados com sucesso.
Códigos de Erro
| Código | Descrição |
|---|---|
| 400 | Dados inválidos ou formato incorreto no corpo da requisição. |
| 401 | Token de autenticação ausente ou inválido. |
| 403 | Acesso não autorizado para atualizar esta Empresa. |
| 404 | Empresa não encontrada para o business_id informado. |
| 422 | Violação de regras de negócio ou inconsistência nos dados enviados. |
| 500 | Erro interno inesperado no servidor. |