Geral · BancosCadastro

Consulta dos dados bancarios

POSThttps://app.omie.com.br/api/v1/geral/bancos/WSDL

2consultas

0alterações

Claude · MCPpelos assistentes de IA

JSON · XMLformato

ConsultarBanco

consultaClaudeMCP

Consulta os dados de um banco específico.

Obrigatórios 1

Campo	Tipo	Descrição
`codigo`	texto · até 3	código do Banco / Instituíção Financeira.

Retorno 23O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cnab_altve`	texto	CNAB - Permite a Alteração do Vencimento da Cobrança
`cnab_altvl`	texto	CNAB - Permite a Alteração do Valor da Cobrança
`cnab_cob`	texto	CNAB - Remessa de Cobrança [S/N]
`cnab_pag`	texto	CNAB - Remessa de Pagamento [S/N]
`cod_compen`	texto	Código da Instituição Bancária para Compensação
`cod_ispb`	texto	Código Identificador do Sistema de Pagamento Brasileiro
`codigo`	texto	Código do Banco / Instituição Financeira
`crawler_sn`	texto	Crawler - Possui integração automática com o Crawler [S/N]
`cwr_cobrem`	texto	Crawler - Possui remessa do CNAB de Cobrança pelo Crawler [S/N]
`cwr_cobret`	texto	Crawler - Possui retorno do CNAB de Cobrança pelo Crawler [S/N]
`cwr_extr`	texto	Crawler - Possui retorno do Extrato da Conta Corrente pelo Crawler [S/N]
`cwr_pagrem`	texto	Crawler - Possui remessa do CNAB de Pagamentos pelo Crawler [S/N]
`cwr_pagret`	texto	Crawler - Possui retorno do CNAB de Pagamentos pelo Crawler [S/N]
`descond_qt`	número inteiro	Quantidade de Descontos Condicionais permitidos para o Banco
`descond_sn`	texto	Possui Desconto Condicional [S/N]
`entf_cnpj`	texto	CNPJ da instituição financeira de pagamento.
`nome`	texto	Nome do Banco
`obank_cobr`	texto	Possui integração dos boletos de cobrança via API [S/N]
`obank_extr`	texto	Possui integração dos extratos bancários via API [S/N]
`obank_pagt`	texto	Possui integração dos pagamentos via API [S/N]
`obank_pix`	texto	Possui integração do PIX via API [S/N]
`obank_sn`	texto	Possui integração automática com banco via API [S/N]
`tipo`	texto	Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)

POST /api/v1/geral/bancos/

curl -s https://app.omie.com.br/api/v1/geral/bancos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarBanco", "param": [{"codigo": ""}]}'

import os
import requests

corpo = {'call': 'ConsultarBanco', 'param': [{'codigo': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/bancos/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
    json=corpo,
    timeout=60,
)
print(resp.json())

const resp = await fetch("https://app.omie.com.br/api/v1/geral/bancos/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ConsultarBanco",
    "param": [
      {
        "codigo": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/bancos/");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
    "call": "ConsultarBanco",
    "param": [
        {
            "codigo": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/bancos/")
corpo = <<~'JSON'
{
  "call": "ConsultarBanco",
  "param": [
    {
      "codigo": ""
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "ConsultarBanco",
  "param": [
    {
      "codigo": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/bancos/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(corpo))
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/v1/geral/bancos/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ConsultarBanco"", ""param"": [{""codigo"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarBancos

consultaClaudeMCP

Exibe uma lista com os banco cadastrados.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 7Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`apenas_importado_api`	texto · até 1	DEPRECATED
`nome`	texto · até 40	Nome do Banco
`ordem_descrescente`	texto · até 1	DEPRECATED
`ordenar_por`	texto · até 100	DEPRECATED
`pagina`	número inteiro	Número da página para resgatar os dados.
`registros_por_pagina`	número inteiro	Número de registros a serem exibidos por página. Máximo 50.
`tipo`	texto · até 2	Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`fin_banco_cadastro`	lista de objetos	Cadastro de bancos / instituições financeiras.
`fin_banco_cadastro[].cnab_altve`	texto	CNAB - Permite a Alteração do Vencimento da Cobrança
`fin_banco_cadastro[].cnab_altvl`	texto	CNAB - Permite a Alteração do Valor da Cobrança
`fin_banco_cadastro[].cnab_cob`	texto	CNAB - Remessa de Cobrança [S/N]
`fin_banco_cadastro[].cnab_pag`	texto	CNAB - Remessa de Pagamento [S/N]
`fin_banco_cadastro[].cod_compen`	texto	Código da Instituição Bancária para Compensação
`fin_banco_cadastro[].cod_ispb`	texto	Código Identificador do Sistema de Pagamento Brasileiro
`fin_banco_cadastro[].codigo`	texto	Código do Banco / Instituição Financeira
`fin_banco_cadastro[].crawler_sn`	texto	Crawler - Possui integração automática com o Crawler [S/N]
`fin_banco_cadastro[].cwr_cobrem`	texto	Crawler - Possui remessa do CNAB de Cobrança pelo Crawler [S/N]
`fin_banco_cadastro[].cwr_cobret`	texto	Crawler - Possui retorno do CNAB de Cobrança pelo Crawler [S/N]
`fin_banco_cadastro[].cwr_extr`	texto	Crawler - Possui retorno do Extrato da Conta Corrente pelo Crawler [S/N]
`fin_banco_cadastro[].cwr_pagrem`	texto	Crawler - Possui remessa do CNAB de Pagamentos pelo Crawler [S/N]
`fin_banco_cadastro[].cwr_pagret`	texto	Crawler - Possui retorno do CNAB de Pagamentos pelo Crawler [S/N]
`fin_banco_cadastro[].descond_qt`	número inteiro	Quantidade de Descontos Condicionais permitidos para o Banco
`fin_banco_cadastro[].descond_sn`	texto	Possui Desconto Condicional [S/N]
`fin_banco_cadastro[].entf_cnpj`	texto	CNPJ da instituição financeira de pagamento.
`fin_banco_cadastro[].nome`	texto	Nome do Banco
`fin_banco_cadastro[].obank_cobr`	texto	Possui integração dos boletos de cobrança via API [S/N]
`fin_banco_cadastro[].obank_extr`	texto	Possui integração dos extratos bancários via API [S/N]
`fin_banco_cadastro[].obank_pagt`	texto	Possui integração dos pagamentos via API [S/N]
`fin_banco_cadastro[].obank_pix`	texto	Possui integração do PIX via API [S/N]
`fin_banco_cadastro[].obank_sn`	texto	Possui integração automática com banco via API [S/N]
`fin_banco_cadastro[].tipo`	texto	Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)
`pagina`	número inteiro	Número da página retornada
`registros`	número inteiro	Número de registros retornados na página.
`total_de_paginas`	número inteiro	Número total de páginas
`total_de_registros`	número inteiro	total de registros encontrados

POST /api/v1/geral/bancos/

curl -s https://app.omie.com.br/api/v1/geral/bancos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarBancos", "param": [{"pagina": 1, "registros_por_pagina": 100}]}'

import os
import requests

corpo = {'call': 'ListarBancos', 'param': [{'pagina': 1, 'registros_por_pagina': 100}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/geral/bancos/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
    json=corpo,
    timeout=60,
)
print(resp.json())

const resp = await fetch("https://app.omie.com.br/api/v1/geral/bancos/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarBancos",
    "param": [
      {
        "pagina": 1,
        "registros_por_pagina": 100
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/geral/bancos/");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
    "call": "ListarBancos",
    "param": [
        {
            "pagina": 1,
            "registros_por_pagina": 100
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/geral/bancos/")
corpo = <<~'JSON'
{
  "call": "ListarBancos",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 100
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "ListarBancos",
  "param": [
    {
      "pagina": 1,
      "registros_por_pagina": 100
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/geral/bancos/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(corpo))
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/v1/geral/bancos/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarBancos"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 100}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

ConsultarBanco
ListarBancos