Documentação da API

POST /disable_bank_account

Resumo

Este endpoint permite desativar uma conta bancária existente em uma unidade específica.

---

Descrição

Utilize este endpoint para desativar logicamente uma conta bancária, alterando seu status para inativo. 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 desativada.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/disable_bank_account' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "id_token": "<id_token>"
}'

---

Resposta

200 OK

Desativação realizada com sucesso.

{
  "success": true,
  "message": "Bank account disabled successfully."
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing parameters"	Algum parâmetro obrigatório (access_token, unit_token, id_token) não foi enviado.
403	"Invalid data"	Token de autenticação inválido ou não autorizado.
500	"Something went wrong. Please try again later."	Erro interno no servidor.

---

Observações

• A desativação é lógica, ou seja, a conta bancária não é removida do banco de dados, apenas marcada como inativa (active: false).
• Certifique-se de que os tokens estejam válidos e que a conta bancária exista no sistema.
• A operação é realizada de forma transacional, garantindo a consistência dos dados no banco.