Formas de Pagamento · API Hooked

Visão Geral

O módulo Formas de Pagamento gerencia os meios de pagamento aceitos pelo sistema, como dinheiro, cartão de crédito, TEF, boleto e outros. Cada forma de pagamento pode ser vinculada a um tipo de documento financeiro e configurada com regras específicas (troco, TEF, crédito, etc.).

Base URL

/api/formas-pagamento

Endpoints

GET /api/formas-pagamento

Descrição: Retorna a lista de todas as formas de pagamento cadastradas.

Parâmetros

Nenhum.

Resposta de Sucesso `200`

[
  {
    "id": 1,
    "nome": "Dinheiro",
    "origem": "01",
    "ativo": true,
    "tipo": null,
    "tef": false,
    "credito": false,
    "permitirTroco": true,
    "configuracaoFiscal": "01",
    "documentoId": 3,
    "documentoDescricao": "Recibo"
  },
  {
    "id": 2,
    "nome": "Cartão de Crédito",
    "origem": "03",
    "ativo": true,
    "tipo": "credito",
    "tef": true,
    "credito": true,
    "permitirTroco": false,
    "configuracaoFiscal": "03",
    "documentoId": 1,
    "documentoDescricao": "Duplicata"
  }
]

Campos da Resposta

Campo	Tipo	Descrição
`id`	integer (int64)	Identificador da forma de pagamento
`nome`	string	Nome da forma de pagamento
`origem`	string	Origem da forma de pagamento. Ver Parâmetros Base
`ativo`	boolean	Status ativo
`tipo`	string	Tipo da forma de pagamento. Ver Parâmetros Base
`tef`	boolean	Aceita integração TEF
`credito`	boolean	É uma operação de crédito
`permitirTroco`	boolean	Permite troco
`configuracaoFiscal`	string	Código fiscal para emissão de NF-e
`documentoId`	integer	ID do tipo de documento vinculado
`documentoDescricao`	string	Descrição do tipo de documento

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/formas-pagamento" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Python

import requests

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

import (
    "io"
    "net/http"
)

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

Descrição: Cadastra uma nova forma de pagamento.

Corpo da Requisição

{
  "nome": "PIX",
  "origem": "17",
  "ativo": true,
  "tipo": null,
  "tef": false,
  "credito": false,
  "permitirTroco": false,
  "configuracaoFiscal": "17",
  "documentoId": 3
}

Campo	Tipo	Obrigatório	Regras	Descrição
`nome`	string	✓	mín. 1 caractere	Nome da forma de pagamento
`origem`	string	✓	mín. 1 caractere	Origem da forma de pagamento. Ver Parâmetros Base
`configuracaoFiscal`	string	✓	mín. 1 caractere	Código fiscal
`documentoId`	integer (int64)	✓	—	ID do tipo de documento
`ativo`	boolean	—	—	Status ativo
`tipo`	string	—	—	Tipo da forma de pagamento. Ver Parâmetros Base
`tef`	boolean	—	—	Aceita TEF
`credito`	boolean	—	—	É crédito
`permitirTroco`	boolean	—	—	Permite troco

Parâmetros Base

Campo	Valores conhecidos
`tipo`	`"D"` (único valor presente nas formas cadastradas — Dinheiro, Cartão Débito, Parcelado). Significado exato dos códigos não documentado pela API
`origem`	`"V"` = à Vista, `"P"` = à Prazo

Resposta de Sucesso `200`

Retorna a forma de pagamento criada.

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/formas-pagamento" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"nome":"PIX","origem":"17","ativo":true,"tipo":null,"tef":false,"credito":false,"permitirTroco":false,"configuracaoFiscal":"17","documentoId":3}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/formas-pagamento', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "nome": "PIX",
  "origem": "17",
  "ativo": true,
  "tipo": null,
  "tef": false,
  "credito": false,
  "permitirTroco": false,
  "configuracaoFiscal": "17",
  "documentoId": 3
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/formas-pagamento',
    headers={'Authorization': 'Bearer {token}'},
    json={'nome': 'PIX', 'origem': '17', 'ativo': True, 'tipo': None, 'tef': False, 'credito': False, 'permitirTroco': False, 'configuracaoFiscal': '17', 'documentoId': 3}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"nome":"PIX","origem":"17","ativo":true,"tipo":null,"tef":false,"credito":false,"permitirTroco":false,"configuracaoFiscal":"17","documentoId":3}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/formas-pagamento", 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/formas-pagamento');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'nome' => 'PIX',
        'origem' => '17',
        'ativo' => true,
        'tipo' => null,
        'tef' => false,
        'credito' => false,
        'permitirTroco' => false,
        'configuracaoFiscal' => '17',
        'documentoId' => 3
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/formas-pagamento",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/formas-pagamento",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"nome\":\"PIX\",\"origem\":\"17\",\"ativo\":true,\"tipo\":null,\"tef\":false,\"credito\":false,\"permitirTroco\":false,\"configuracaoFiscal\":\"17\",\"documentoId\":3}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/formas-pagamento/{id}

Descrição: Retorna os dados de uma forma de pagamento pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID da forma de pagamento

Resposta de Sucesso `200`

Retorna o objeto no mesmo formato da listagem.

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Forma de pagamento não encontrada
`500`	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

import (
    "io"
    "net/http"
)

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

Descrição: Atualiza os dados de uma forma de pagamento existente.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID da forma de pagamento a atualizar

Corpo da Requisição

Mesmo formato do POST, com o campo id preenchido.

Resposta de Sucesso `200`

Retorna a forma de pagamento atualizada.

Códigos de Erro

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

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

import (
    "io"
    "net/http"
)

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

DELETE /api/formas-pagamento/{id}

Descrição: Remove uma forma de pagamento pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID da forma de pagamento a remover

Resposta de Sucesso `200`

Retorna a forma de pagamento removida.

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Forma de pagamento não encontrada
`500`	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

import (
    "io"
    "net/http"
)

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

Códigos de Erro

Exemplos de Código

Corpo da Requisição

Parâmetros Base

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`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`