Documentação da API

POST /update_bank_account

Resumo

Este endpoint permite atualizar os dados de uma conta bancária existente em uma unidade específica.

---

Descrição

Utilize este endpoint para modificar informações de uma conta bancária, como banco, agência, número da conta, saldo inicial, entre outros. A conta deve existir e estar associada à unidade informada.

---

Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token identificador da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token	string	Sim	Token identificador da conta bancária a ser atualizada.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_bank	string	Não	Identificador do banco.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_bank_type	string	Não	Identificador do tipo de banco.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
agency	string	Não	Número da agência bancária.	1234
current_account	string	Não	Número da conta corrente.	56789
observation	string	Não	Observações sobre a conta.	Conta principal atualizada
code_bank	string	Não	Código do banco.	033
dv_agencia	string	Não	Dígito verificador da agência.	5
dv_conta	string	Não	Dígito verificador da conta.	9
nick_name	string	Não	Apelido da conta.	Conta Principal Atualizada
opening_balance	number	Não	Saldo inicial da conta.	1500.75
opening_balance_date	string	Não	Data do saldo inicial (formato DD/MM/YYYY).	01/02/2025

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/update_bank_account' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "id_token": "<id_token>",
  "id_token_bank": "<id_token_bank>",
  "id_token_bank_type": "<id_token_bank_type>",
  "agency": "<agency>",
  "current_account": "<current_account>",
  "observation": "<observation>",
  "code_bank": "<code_bank>",
  "dv_agencia": "<dv_agencia>",
  "dv_conta": "<dv_conta>",
  "nick_name": "<nick_name>",
  "opening_balance": <opening_balance>,
  "opening_balance_date": "<opening_balance_date>"
}'

---

Resposta

200 OK

Atualização realizada com sucesso.

{
  "success": true,
  "message": "Bank account updated successfully",
  "data": {
    "token": "<token>"
  }
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing required parameters"	Algum parâmetro obrigatório (access_token, unit_token, id_token) não foi enviado.
400	"No fields provided to update"	Nenhum campo válido foi fornecido para atualização.
403	"Invalid data"	Token de autenticação inválido ou não autorizado.
404	"Unit not found"	A unidade com o unit_token fornecido não foi encontrada.
404	"Bank account not found or not updated"	A conta bancária com o id_token fornecido não foi encontrada ou não foi atualizada.
500	"Something went wrong. Please try again later."	Erro interno no servidor.

---

Observações

• Pelo menos um dos campos opcionais (id_token_bank, id_token_bank_type, agency, current_account, observation, code_bank, dv_agencia, dv_conta, nick_name, opening_balance, opening_balance_date) deve ser fornecido para realizar a atualização.
• O campo opening_balance_date deve estar no formato DD/MM/YYYY e será formatado para armazenamento.
• O campo opening_balance será formatado como valor monetário para armazenamento.
• A atualização é realizada de forma transacional, garantindo a consistência dos dados no banco.
• Certifique-se de que os tokens estejam válidos e que a unidade e a conta bancária existam no sistema.