Pular para o conteúdo principal

Documentação da API

POST /get_bank_account​

Resumo​

Este endpoint retorna contas bancária com base nos parâmetros fornecidos pelo usuário.

Descrição​

Utilize este endpoint para obter uma lista de contas bancária filtradas conforme os parâmetros passados na requisição.

Requisição​

Body da Requisição​

O corpo da requisição deve ser um objeto JSON e é obrigatório. A seguir estão os parâmetros aceitos:

ParâmetroTipoDescriçãoExemplo
access_tokenstringToken de acesso (obrigatório).b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringToken da unidade (obrigatório).e6988e9e-b0c1-410c-ae08-aed7c64ac71f

Requisição de exemplo​

curl -s 'https://portal.fipli.pro/api/v1/get_bank_account' -d '{"access_token": "b31643fc-a45f-448c-99ee-736a547f6989", "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f"}' -H 'Content-Type: application/json' -H 'userlogged: <jwt>'
{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f"
}

Respostas​

200 OK​

Em caso de sucesso, a resposta terá o seguinte formato:

{
  "success": true,
  "data": [
    {
      "dv_agency": "1", // Dígito verificador da agência bancária
      "dv_account": "4", // Dígito verificador da conta corrente
      "token": "453d873f-2d40-467d-b36f-ee4b064234ff", // Identificador único da conta bancária
      "nick_name": "Saldo", // Nome curto ou apelido da conta, usado para fácil identificação
      "agency": "1114", // Número da agência bancária
      "current_account": "411", // Número da conta corrente
      "observation": null, // Observações adicionais sobre a conta (pode ser null)
      "opening_balance_date": "04/02/2025", // Data em que o saldo inicial foi registrado
      "opening_balance": "11111.44", // Saldo da conta na data de abertura (formato string para manter precisão e compatibilidade)
      "bank_name": "Nubank", // Nome do banco
      "cod_bank": "260", // Código do banco no padrão FEBRABAN
      "description": "Conta Corrente", // Tipo do banco
      "code_bank": "123456789", // Código interno ou identificador único da conta no sistema
      "real_balance": "11099.02" // Saldo atual real da conta (formato string para manter precisão)
    }
  ]
}

4xx e 5xx Erros​

Em caso de erro, success sera igual a false, seguido por uma menssagem de erro, por exemplo:

{ 
  "success": false, 
  "error": "Missing parameters"
}