Bancos · API Hooked

Visão Geral

O módulo Bancos gerencia o cadastro de instituições bancárias utilizadas no sistema. Permite criar, consultar, atualizar e remover bancos, incluindo código FEBRABAN, dígito verificador, tipo de cobrança e parâmetros de layout para geração de arquivos de remessa.

Base URL

/api/bancos

Todos os endpoints requerem autenticação via Bearer Token:
Authorization: Bearer {token}

Endpoints

GET /api/bancos

Descrição: Retorna uma lista paginada de bancos cadastrados. Suporta filtro por nome e ordenação.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`nome`	string	query	—	Filtra bancos pelo nome
`property`	string	query	—	Campo pelo qual ordenar
`orderBy`	string	query	—	Direção: `asc` ou `desc`
`pageNumber`	integer	query	—	Número da página (padrão: `1`)
`pageSize`	integer	query	—	Registros por página (padrão: `20`)

Resposta de Sucesso `200`

{
  "pagination": {
    "currentPage": 1,
    "totalPages": 3,
    "pageSize": 20,
    "totalCount": 52,
    "hasPrevious": false,
    "hasNext": true
  },
  "data": [
    {
      "id": 1,
      "nome": "Banco do Brasil",
      "codigo": "001",
      "digito": "9",
      "tipoCobranca": 1,
      "layoutVersaoArquivo": 103,
      "layoutVersaoLote": 42,
      "localPagamento": "Pagável em qualquer banco",
      "orientacaoBanco": null,
      "numeroCorrespondente": null
    }
  ],
  "summary": null
}

Campos da Resposta — `data[]`

Campo	Tipo	Descrição
`id`	integer (int64)	Identificador único do banco
`nome`	string	Nome da instituição bancária
`codigo`	string	Código FEBRABAN do banco
`digito`	string	Dígito verificador do código
`tipoCobranca`	integer	Tipo de cobrança utilizado
`layoutVersaoArquivo`	integer	Versão do layout do arquivo de remessa
`layoutVersaoLote`	integer	Versão do layout do lote de remessa
`localPagamento`	string	Texto do local de pagamento no boleto
`orientacaoBanco`	string	Instruções/orientações ao banco
`numeroCorrespondente`	string	Número do banco correspondente

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/bancos" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/bancos', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/bancos',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/bancos", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/bancos');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/bancos",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/bancos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

POST /api/bancos

Descrição: Cria um novo banco no sistema.

Corpo da Requisição

{
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 1,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco",
  "orientacaoBanco": null,
  "numeroCorrespondente": null
}

Campo	Tipo	Obrigatório	Descrição
`nome`	string	—	Nome da instituição bancária
`codigo`	string	—	Código FEBRABAN
`digito`	string	—	Dígito verificador
`tipoCobranca`	integer	—	Tipo de cobrança
`layoutVersaoArquivo`	integer	—	Versão do layout do arquivo
`layoutVersaoLote`	integer	—	Versão do layout do lote
`localPagamento`	string	—	Local de pagamento para boleto
`orientacaoBanco`	string	—	Orientações ao banco
`numeroCorrespondente`	string	—	Número do banco correspondente

Resposta de Sucesso `200`

{
  "id": 10,
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 1,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco",
  "orientacaoBanco": null,
  "numeroCorrespondente": null
}

Códigos de Erro

Código	Descrição
`400`	Dados inválidos
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/bancos" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"nome":"Banco do Brasil","codigo":"001","digito":"9","tipoCobranca":1,"layoutVersaoArquivo":103,"layoutVersaoLote":42,"localPagamento":"Pagável em qualquer banco","orientacaoBanco":null,"numeroCorrespondente":null}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/bancos', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 1,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco",
  "orientacaoBanco": null,
  "numeroCorrespondente": null
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/bancos',
    headers={'Authorization': 'Bearer {token}'},
    json={'nome': 'Banco do Brasil', 'codigo': '001', 'digito': '9', 'tipoCobranca': 1, 'layoutVersaoArquivo': 103, 'layoutVersaoLote': 42, 'localPagamento': 'Pagável em qualquer banco', 'orientacaoBanco': None, 'numeroCorrespondente': None}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"nome":"Banco do Brasil","codigo":"001","digito":"9","tipoCobranca":1,"layoutVersaoArquivo":103,"layoutVersaoLote":42,"localPagamento":"Pagável em qualquer banco","orientacaoBanco":null,"numeroCorrespondente":null}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/bancos", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/bancos');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'nome' => 'Banco do Brasil',
        'codigo' => '001',
        'digito' => '9',
        'tipoCobranca' => 1,
        'layoutVersaoArquivo' => 103,
        'layoutVersaoLote' => 42,
        'localPagamento' => 'Pagável em qualquer banco',
        'orientacaoBanco' => null,
        'numeroCorrespondente' => null
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/bancos",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/bancos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"nome\":\"Banco do Brasil\",\"codigo\":\"001\",\"digito\":\"9\",\"tipoCobranca\":1,\"layoutVersaoArquivo\":103,\"layoutVersaoLote\":42,\"localPagamento\":\"Pagável em qualquer banco\",\"orientacaoBanco\":null,\"numeroCorrespondente\":null}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/bancos/{id}

Descrição: Retorna os dados de um banco específico pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do banco

Resposta de Sucesso `200`

{
  "id": 1,
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 1,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco",
  "orientacaoBanco": null,
  "numeroCorrespondente": null
}

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Banco não encontrado
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/bancos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/bancos/{id}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/bancos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/bancos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/bancos/{id}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/bancos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/bancos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/bancos/{id}

Descrição: Atualiza os dados de um banco existente.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do banco a ser atualizado

Corpo da Requisição

{
  "id": 1,
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 2,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco até o vencimento",
  "orientacaoBanco": "Não receber após 30 dias",
  "numeroCorrespondente": null
}

Resposta de Sucesso `200`

Retorna o objeto atualizado com a mesma estrutura do POST /api/bancos.

Códigos de Erro

Código	Descrição
`400`	Dados inválidos
`401`	Token ausente ou inválido
`404`	Banco não encontrado
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/bancos/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"id":1,"nome":"Banco do Brasil","codigo":"001","digito":"9","tipoCobranca":2,"layoutVersaoArquivo":103,"layoutVersaoLote":42,"localPagamento":"Pagável em qualquer banco até o vencimento","orientacaoBanco":"Não receber após 30 dias","numeroCorrespondente":null}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/bancos/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "id": 1,
  "nome": "Banco do Brasil",
  "codigo": "001",
  "digito": "9",
  "tipoCobranca": 2,
  "layoutVersaoArquivo": 103,
  "layoutVersaoLote": 42,
  "localPagamento": "Pagável em qualquer banco até o vencimento",
  "orientacaoBanco": "Não receber após 30 dias",
  "numeroCorrespondente": null
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/bancos/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'id': 1, 'nome': 'Banco do Brasil', 'codigo': '001', 'digito': '9', 'tipoCobranca': 2, 'layoutVersaoArquivo': 103, 'layoutVersaoLote': 42, 'localPagamento': 'Pagável em qualquer banco até o vencimento', 'orientacaoBanco': 'Não receber após 30 dias', 'numeroCorrespondente': None}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"id":1,"nome":"Banco do Brasil","codigo":"001","digito":"9","tipoCobranca":2,"layoutVersaoArquivo":103,"layoutVersaoLote":42,"localPagamento":"Pagável em qualquer banco até o vencimento","orientacaoBanco":"Não receber após 30 dias","numeroCorrespondente":null}`)
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/bancos/{id}", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/bancos/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'id' => 1,
        'nome' => 'Banco do Brasil',
        'codigo' => '001',
        'digito' => '9',
        'tipoCobranca' => 2,
        'layoutVersaoArquivo' => 103,
        'layoutVersaoLote' => 42,
        'localPagamento' => 'Pagável em qualquer banco até o vencimento',
        'orientacaoBanco' => 'Não receber após 30 dias',
        'numeroCorrespondente' => null
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/bancos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/bancos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"id\":1,\"nome\":\"Banco do Brasil\",\"codigo\":\"001\",\"digito\":\"9\",\"tipoCobranca\":2,\"layoutVersaoArquivo\":103,\"layoutVersaoLote\":42,\"localPagamento\":\"Pagável em qualquer banco até o vencimento\",\"orientacaoBanco\":\"Não receber após 30 dias\",\"numeroCorrespondente\":null}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

DELETE /api/bancos/{id}

Descrição: Remove um banco do sistema pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do banco a ser removido

Resposta de Sucesso `200`

Retorna o objeto removido com a mesma estrutura do GET /api/bancos/{id}.

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Banco não encontrado
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X DELETE "https://api.app.hooked.com.br/api/bancos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/bancos/{id}', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.delete(
    'https://api.app.hooked.com.br/api/bancos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/bancos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/bancos/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — DELETE /api/bancos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/bancos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

Visão Geral

Base URL

Endpoints

Parâmetros

Resposta de Sucesso 200

Campos da Resposta — data[]

Códigos de Erro

Exemplos de Código

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Resposta de Sucesso `200`

Campos da Resposta — `data[]`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`