Remessas

Visão Geral

O módulo Remessas gerencia os arquivos de remessa bancária, utilizados para enviar lotes de cobranças ou pagamentos a instituições financeiras. Permite criar, consultar, gerar e baixar os arquivos de remessa no formato CNAB.

Endpoints

GET /api/remessas

Descrição: Lista todas as remessas cadastradas com suporte a paginação e filtros. Autenticação: Obrigatória

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
pagina	integer	Não	Número da página (padrão: 1)
quantidade	integer	Não	Itens por página (padrão: 20)
contaId	string	Não	Filtrar por conta bancária
dataInicio	string (date)	Não	Data inicial do período
dataFim	string (date)	Não	Data final do período
status	string	Não	Status da remessa: pendente, gerada, enviada

Resposta de Sucesso

{
  "dados": [
    {
      "id": "uuid",
      "numero": 1,
      "contaId": "uuid",
      "contaNome": "Banco do Brasil - CC 12345-6",
      "dataGeracao": "2024-01-15T10:00:00Z",
      "status": "gerada",
      "quantidadeTitulos": 10,
      "valorTotal": 5000.00
    }
  ],
  "total": 20,
  "pagina": 1,
  "quantidade": 20
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
500	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/remessas", 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/remessas');
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/remessas",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/remessas",
        "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/remessas

Descrição: Cria uma nova remessa bancária no sistema. Autenticação: Obrigatória

Corpo da Requisição (Request Body)

{
  "contaId": "uuid",
  "descricao": "Remessa de cobranças - Janeiro 2024",
  "titulos": [
    "uuid-titulo-1",
    "uuid-titulo-2"
  ]
}

Resposta de Sucesso

{
  "id": "uuid",
  "numero": 1,
  "contaId": "uuid",
  "status": "pendente",
  "quantidadeTitulos": 2
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/remessas" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"contaId":"uuid","descricao":"Remessa de cobranças - Janeiro 2024","titulos":["uuid-titulo-1","uuid-titulo-2"]}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/remessas', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "contaId": "uuid",
  "descricao": "Remessa de cobranças - Janeiro 2024",
  "titulos": [
    "uuid-titulo-1",
    "uuid-titulo-2"
  ]
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/remessas',
    headers={'Authorization': 'Bearer {token}'},
    json={'contaId': 'uuid', 'descricao': 'Remessa de cobranças - Janeiro 2024', 'titulos': ['uuid-titulo-1', 'uuid-titulo-2']}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload := []byte(`{"contaId":"uuid","descricao":"Remessa de cobranças - Janeiro 2024","titulos":["uuid-titulo-1","uuid-titulo-2"]}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/remessas", 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/remessas');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'contaId' => 'uuid',
        'descricao' => 'Remessa de cobranças - Janeiro 2024',
        'titulos' => [
            'uuid-titulo-1',
            'uuid-titulo-2'
        ]
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/remessas",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/remessas",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"contaId\":\"uuid\",\"descricao\":\"Remessa de cobranças - Janeiro 2024\",\"titulos\":[\"uuid-titulo-1\",\"uuid-titulo-2\"]}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/remessas/{id}

Descrição: Retorna os detalhes de uma remessa pelo seu identificador único. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da remessa

Resposta de Sucesso

{
  "id": "uuid",
  "numero": 1,
  "contaId": "uuid",
  "contaNome": "Banco do Brasil - CC 12345-6",
  "descricao": "Remessa de cobranças - Janeiro 2024",
  "dataGeracao": "2024-01-15T10:00:00Z",
  "status": "gerada",
  "nomeArquivo": "remessa_001.txt",
  "titulos": [
    {
      "id": "uuid",
      "numero": "001",
      "valor": 2500.00,
      "vencimento": "2024-02-01"
    }
  ]
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Remessa não encontrada

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/remessas/{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/remessas/{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/remessas/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/remessas/{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/remessas/{id}

Descrição: Atualiza os dados de uma remessa existente. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da remessa

Corpo da Requisição (Request Body)

{
  "descricao": "Remessa de cobranças - Janeiro 2024 (revisada)"
}

Resposta de Sucesso

{
  "id": "uuid",
  "descricao": "Remessa de cobranças - Janeiro 2024 (revisada)"
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado
404	Remessa não encontrada

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/remessas/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"descricao":"Remessa de cobranças - Janeiro 2024 (revisada)"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/remessas/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "descricao": "Remessa de cobranças - Janeiro 2024 (revisada)"
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/remessas/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'descricao': 'Remessa de cobranças - Janeiro 2024 (revisada)'}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload, _ := json.Marshal({"descricao":"Remessa de cobranças - Janeiro 2024 (revisada)"})
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/remessas/{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/remessas/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'descricao' => 'Remessa de cobranças - Janeiro 2024 (revisada)'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/remessas/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/remessas/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"descricao\":\"Remessa de cobranças - Janeiro 2024 (revisada)\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

DELETE /api/remessas/{id}

Descrição: Remove uma remessa do sistema pelo seu identificador. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da remessa

Resposta de Sucesso

{
  "mensagem": "Remessa removida com sucesso"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Remessa não encontrada
409	Remessa já enviada não pode ser removida

Exemplos de Código

cURL

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

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/remessas/{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/remessas/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/remessas/{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/remessas/{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/remessas/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/remessas/{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/remessas/{id}/gerar

Descrição: Gera o arquivo CNAB da remessa, preparando-o para envio ao banco. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da remessa

Resposta de Sucesso

{
  "id": "uuid",
  "status": "gerada",
  "nomeArquivo": "remessa_001.txt",
  "dataGeracao": "2024-01-15T10:00:00Z"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Remessa não encontrada
422	Remessa sem títulos ou com configuração inválida

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/remessas/{id}/gerar", 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/remessas/{id}/gerar');
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 — PUT /api/remessas/{id}/gerar",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/remessas/{id}/gerar",
        "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": {}
}

---

GET /api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}

Descrição: Faz o download do arquivo de remessa gerado. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
contaId	string (uuid)	Sim	Identificador da conta bancária
nomeArquivo	string	Sim	Nome do arquivo de remessa

Resposta de Sucesso

Retorna o arquivo CNAB em formato texto para download.

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Arquivo não encontrado

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}" \
  -H "Authorization: Bearer {token}" \
  -o arquivo

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const blob = await response.blob();
// Node.js: use response.buffer() e salve com fs.writeFile

Python

import requests

response = requests.get(
    'https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}',
    headers={'Authorization': 'Bearer {token}'},
)
with open('arquivo', 'wb') as f:
    f.write(response.content)

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
arquivo, _ := os.Create("arquivo")
defer arquivo.Close()
io.Copy(arquivo, resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$arquivo = curl_exec($ch);
curl_close($ch);
file_put_contents('arquivo', $arquivo);

n8n

{
  "name": "Hooked API — GET /api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/remessas/{contaId}/recuperar-arquivo/{nomeArquivo}",
        "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": {}
}