Pular para o conteúdo principal

Bancos

Esta seção documenta os endpoints de listagem e consulta de bancos, que são utilizados nas configurações financeiras de um Corban para definir os dados bancários necessários para realizar pagamentos diretos.

Listar Bancos​

Este serviço permite listar bancos disponíveis com paginação para navegação mais eficiente.

Endpoint para Listar Bancos​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/bank

Parâmetros de Consulta​

  • page (number, obrigatório): O número da página a ser exibida.
  • pageSize (number, obrigatório): O número de resultados por página.

Exemplo de Requisição com curl​

curl -X GET 'https://bff-dev.granatech.com.br/api/bank?page=1&pageSize=10'

Exemplo de Resposta​

A resposta é composta por uma lista de bancos e o número total de páginas disponíveis.

{
  "data": [
    {
      "id": "104",
      "name": "Caixa Econômica Federal",
      "enabled": true,
      "createdAt": "2023-10-01T12:00:00.000Z"
    },
    {
      "id": "623",
      "name": "Banco Pan",
      "enabled": true,
      "createdAt": "2023-10-01T12:00:00.000Z"
    }
  ],
  "totalPages": 5
}

Nota: O campo id representa o número de identificação do banco no sistema FEBRABAN.

Consultar Banco por ID​

Este serviço permite buscar os dados de um banco específico pelo seu ID.

Endpoint para Consultar Banco​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/bank/{id}

Parâmetros de URL​

  • id (string, obrigatório): O ID do banco a ser consultado, correspondente ao número do banco no FEBRABAN.

Exemplo de Requisição com curl​

curl -X GET 'https://bff-dev.granatech.com.br/api/bank/104'

Exemplo de Resposta​

A resposta contém os detalhes do banco consultado.

{
  "data": {
    "id": "104",
    "name": "Caixa Econômica Federal",
    "enabled": true,
    "createdAt": "2023-10-01T12:00:00.000Z"
  }
}

Observações​

  1. Navegação entre Bancos: Utilize o endpoint de listagem para obter bancos com paginação, navegando entre as páginas conforme necessário.
  2. Consulta Específica: Use o endpoint de consulta para buscar dados detalhados de um banco específico, caso o ID (número FEBRABAN) esteja disponível.

Estes endpoints facilitam a seleção e configuração dos dados bancários necessários para operações financeiras no sistema, garantindo que os dados estejam atualizados e acessíveis.