Guide

Consultando lista de Bancos

Este endpoint permite obter a lista de bancos suportados pela V8 para operações de pagamento via dados bancários, sendo fundamental para a criação de propostas com pagamento do tipo transfer.

Endpoint

  • URL: https://bff.v8sistema.com/banks

  • Método: GET

  • Autenticação: Requer token JWT válido no header da requisição.

Requisição

Headers obrigatórios

Authorization: Bearer <access_token>
Content-Type: application/json

Resposta

A resposta consiste em uma lista de bancos disponíveis para operações com seus respectivos dados. Exemplo:

{
  "data": [
    {
      "id": "5fa17fcd-8afd-47bc-9711-f3a4c736bac5",
      "name": "ABC Brasil",
      "code": "246",
      "ispb": "28195667",
      "isTurbo": true,
      "createdAt": "2024-01-04T20:30:32.552Z",
      "updatedAt": "2024-01-04T20:30:32.552Z",
      "deletedAt": null
    }
  ]
}

Campos da Resposta

  • id: string
    Identificador único do banco. Este valor deve ser utilizado no campo bankId ao configurar o pagamento do tipo transfer no endpoint /fgts/proposal.

  • name: string
    Nome da instituição bancária.

  • code: string
    Código bancário oficial da instituição (número do banco).

  • ispb: string
    ISPB (Identificador do Sistema de Pagamentos Brasileiro), utilizado pelo Banco Central para identificar instituições financeiras.

  • isTurbo: boolean
    Indica se o banco está habilitado para o modo turbo de processamento (acesso mais rápido à operação).

  • createdAt: string
    Data de criação do registro no sistema (formato ISO 8601).

  • updatedAt: string
    Data da última atualização do registro (formato ISO 8601).

  • deletedAt: string | null
    Data de exclusão lógica do registro. Se null, o banco está ativo.

Considerações Importantes

  • O valor retornado no campo id deve ser utilizado no momento da criação da proposta (/fgts/proposal) quando a forma de pagamento selecionada for transferência bancária (type: "transfer").

  • Utilize esse endpoint para listar os bancos disponíveis e garantir que apenas instituições válidas sejam utilizadas nos fluxos de pagamento.