Pular para o conteúdo principal

Documentação da API

POST /enable_bank_account

Resumo

Este endpoint permite ativar uma conta bancária previamente desativada em uma unidade específica.


Descrição

Utilize este endpoint para reativar logicamente uma conta bancária, alterando seu status para ativo. 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âmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringSimToken identificador da unidade.e6988e9e-b0c1-410c-ae08-aed7c64ac71f
tokenstringSimToken identificador da conta bancária a ser ativada.a6927665-6d56-4839-ad23-37d48717da13

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/enable_bank_account' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
"unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
"token": "a6927665-6d56-4839-ad23-37d48717da13"
}'

Resposta

200 OK

Ativação realizada com sucesso.

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

Erros Comuns

StatusMensagemDescrição
400"Missing parameters"Algum parâmetro obrigatório (access_token, unit_token, 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 ativação é lógica, ou seja, a conta bancária é marcada como ativa (active: true) no banco de dados.
  • 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.