Serviços Bancários

A API Serviços Bancários é um microsserviço que gerencia boletos e faturas, possibilitanto a visualização de informações detalhadas sobre contas registradas no banco de dados e fichas de compensação.

Figura 1. Diagrama geral do funcionamento da API Serviços Bancários

Endpoints

Todos os endpoints de serviços bancários utilizam a URL base /api/v1/servicos-bancarios/.

Registro de boletos online

Tipo	Endpoint	Documentação	Descrição
`POST`	`/api/v1/servicos-bancarios/fatura/{idFatura}/boletos`	Registra um boleto online	A partir do identificador da fatura e da conta bancária, registra um boleto e retorna a confirmação do registro através das informações do boleto.

Visualização de pagamentos

Tipo	Endpoint	Documentação	Descrição
`GET`	`/api/v1/servicos-bancarios/fatura/{idFatura}/boletos/pagamento`	Visualiza faturas pagas	Permite a visualização, em formato de arquivo, das faturas já pagas através do identificador da fatura e da conta bancária.

Visualização de ficha de compensação

Tipo	Endpoint	Documentação	Descrição
`GET`	`/api/v1/servicos-bancarios/fatura/{idFatura}/boletos/ficha-compensacao`	Visualiza boleto em pdf	Permite a visualização, em formato de arquivo .pdf, de um boleto de um portador através do identificador da fatura e da conta bancária.

Visualização de contas cadastradas

Tipo	Endpoint	Documentação	Descrição
`GET`	`GET /api/v1/servicos-bancarios/contas`	Visualiza contas bancárias do portador	Retorna todas as contas bancárias dos portadores de cartão registradas na sua base de dados.

Casos de uso

Registrando um boleto online

Através do endpoint do endpoint para registro de boleto online, utilizando o idFatura e o idContaBancaria é possível registrar um boleto online, como demonstrado abaixo.

Request body com os valores de idFatura e idContaBancaria:

{
"idFatura": 2001,
"idContaBancaria": 2001
}

Response body com as informações do boleto registrado:

{
  "nomeSacado": "Luke Skywalker",
  "tipoInscricaoSacado": "9",
  "numeroInscricaoSacado": "99999999999",
  "enderecoSacado": {
    "logradouro": "Rua Paraguai",
    "complemento": "AP 999",
    "numero": "9999",
    "bairro": "Cristo Redentor",
    "cep": "58070598",
    "uf": "PB",
    "cidade": "Joao Pessoa"
  },
  "localPagamento": "Pagável preferencialmente nas lojas Varejista 12345 ou na Rede Bancária. ",
  "numeroTitulo": "9999999",
  "nossoNumero": "0000099999999",
  "nossoNumeroDV": "9",
  "dataVencimento": "2012-11-07T01:00:00.000-02:00",
  "dataEmissao": "2012-10-07T09:43:26.450-03:00",
  "dataLimiteDesconto": "2012-11-05T10:43:26.450-02:00",
  "valorTitulo": 99.99,
  "valorPorDiaAtraso": 0,
  "valorDesconto": 0,
  "valorIOF": 0,
  "valorAbatimento": 0,
  "multaAtraso": 0,
  "valorDescontoDiario": 0,
  "mensagemBoleto": "MENSAGEM DO BOLETO.\r\n",
  "linhaDigitavelFormatada": "03399923313180000019721134101019300000000000000",
  "linhaDigitavel": "03399923313180000019721134101019300000000000000",
  "codigoBarras": "03393000000000000009923331800000192113410101",
  "especieTitulo": "99",
  "aceite": "N",
  "exibirDataVencimento": false,
  "mostrarValorBoleto": false,
  "cedente": {
    "nome": "Varejista 12345",
    "tipoInscricao": "9",
    "numeroInscricao": "99.999.999/0009-99",
    "agencia": "9999",
    "agenciaDV": "9",
    "conta": "99999999",
    "contaDV": "9",
    "carteira": "999",
    "codigoContrato": "999-9",
    "codigoCedente": "9999999",
    "codigoBanco": "999-9",
    "tipoBanco": "S",
    "enderecoCedente": {
      "logradouro": "R. Antônio Régis de Brito",
      "numero": "999",
      "bairro": "Pedro Gondim",
      "cep": "58031106",
      "uf": "PB",
      "cidade": "Joao Pessoa"
    }
  }
}

Os endpoints irão retornar os dados que podem ser acessados de acordo com suas credenciais de autenticação. Para mais informações, visite a página de autenticação.