Documentação da API

POST /get_banks

Resumo

Este endpoint permite listar bancos disponíveis no sistema, filtrados por um grupo de bancos específico.

---

Descrição

Utilize este endpoint para obter uma lista de bancos, incluindo seus códigos, nomes, tokens identificadores e grupos associados. A requisição exige autenticação, associação com uma unidade específica e o grupo de bancos como filtro.

---

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
group_bank	string	Sim	Grupo de bancos para filtrar a lista (ex.: AC, CV, CB).	AC

---

Exemplo de Requisição

Curl

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

---

Resposta

200 OK

Lista de bancos retornada com sucesso.

{
  "success": true,
  "data": [
    {
      "code_bank": "001",
      "name": "Banco do Brasil",
      "token": "<token_1>",
      "group_bank": "AC"
    },
    {
      "code_bank": "033",
      "name": "Banco Santander",
      "token": "<token_2>",
      "group_bank": "AC"
    }
  ]
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing parameters"	Algum parâmetro obrigatório (access_token, unit_token, group_bank) 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 lista retornada inclui apenas os bancos que pertencem ao grupo especificado no parâmetro group_bank, ordenados por nome.
• Cada item na resposta contém:
  • code_bank: Código do banco.
  • name: Nome do banco.
  • token: Identificador único do banco.
  • group_bank: Grupo ao qual o banco pertence.
• A operaçã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 exista no sistema.