Finanças · PIX

Inclusão de um PIX

POSThttps://app.omie.com.br/api/v1/financas/pix/WSDL

4consultas

3alterações

Claude · MCPpelos assistentes de IA

JSON · XMLformato

CancelarPix

altera dadosClaudeMCP

Efetua o cancelamento de um PIX

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntPix`	texto · até 60	Código do lançamento gerado pelo integrador.
`lDel`	sim/não	Indica se a conta a receber será excluída ao efetuar o cancelamento do PIX. Ao ser preenchida com true a conta a receber que gerou o PIX será excluída. Pode ser: false true Default: true
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.

Retorno 2O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodStatus`	texto
`cDescStatus`	texto

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarPix", "param": [{"nIdPix": 0, "cCodIntPix": ""}]}'

import os
import requests

corpo = {'call': 'CancelarPix', 'param': [{'nIdPix': 0, 'cCodIntPix': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "CancelarPix",
    "param": [
      {
        "nIdPix": 0,
        "cCodIntPix": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "CancelarPix",
    "param": [
        {
            "nIdPix": 0,
            "cCodIntPix": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "CancelarPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": ""
    }
  ]
}
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": "CancelarPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""CancelarPix"", ""param"": [{""nIdPix"": 0, ""cCodIntPix"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

GerarPix

altera dadosClaudeMCP

Gera o QrCode de um PIX.

Obrigatórios 1

Campo	Tipo	Descrição
`cCodIntPix`	texto · até 60	Código do lançamento gerado pelo integrador.

Opcionais 6Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCnpjCpf`	texto · até 20	CNPJ/CPF do cliente. Informação utilizada para identificar o cadastro do Cliente. Utilize a tag "cbpj_cpf" do método "ListarClientes" da API /api/v1/geral/clientes/ para obter essa informação. Quando as tags "cIdCliente" e cCnpjCpf" não informadas, assumirá que o PIX foi realizado para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.
`cUrlNotif`	texto	URL de CallBack que será acionada quando o pagamento for efetuado.
`nCodTitulo`	número inteiro	ID da conta a receber que irá gerar o PIX. Caso essa tag não seja preenchida uma nova conta a receber será gerada.
`nIdCliente`	número inteiro	Código do cliente. Informação utilizada para identificar o cadastro do Cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API /api/v1/geral/clientes/ para obter essa informação. Quando as tags "cIdCliente" e cCnpjCpf" não informadas, assumirá que o PIX foi realizado para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente. Essa tag não deve ser preenchida quando a tag "nCodTitulo" for informada.
`nIdConta`	número inteiro	Código da Conta Corrente. Caso não informado, assumirá a conta omie.CASH Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. Essa tag não deve ser preenchida quando a tag "nCodTitulo" for informada.
`vValor`	número	Valor do PIX.

Retorno 9O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCliente`	número inteiro	Código do Cliente pagador do PIX.
`cCodIntPix`	texto	Código do lançamento gerado pelo integrador.
`cCodStatus`	texto
`cCopiaCola`	texto	Código gerado a partir do QR Code para pagamento do PIX.
`cDescStatus`	texto
`cQrCode`	texto	String para a renderização do QR Code PIX.
`cUrlPix`	texto	Link para obter o PDF do QrCode do PIX.
`nCodTitulo`	número inteiro	Código da Conta a Receber.
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GerarPix", "param": [{"cCodIntPix": "1670867357", "nIdCliente": 0, "vValor": 1.99, "nIdConta": 0, "cUrlNotif": ""}]}'

import os
import requests

corpo = {'call': 'GerarPix',
 'param': [{'cCodIntPix': '1670867357',
            'nIdCliente': 0,
            'vValor': 1.99,
            'nIdConta': 0,
            'cUrlNotif': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "GerarPix",
    "param": [
      {
        "cCodIntPix": "1670867357",
        "nIdCliente": 0,
        "vValor": 1.99,
        "nIdConta": 0,
        "cUrlNotif": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "GerarPix",
    "param": [
        {
            "cCodIntPix": "1670867357",
            "nIdCliente": 0,
            "vValor": 1.99,
            "nIdConta": 0,
            "cUrlNotif": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "GerarPix",
  "param": [
    {
      "cCodIntPix": "1670867357",
      "nIdCliente": 0,
      "vValor": 1.99,
      "nIdConta": 0,
      "cUrlNotif": ""
    }
  ]
}
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": "GerarPix",
  "param": [
    {
      "cCodIntPix": "1670867357",
      "nIdCliente": 0,
      "vValor": 1.99,
      "nIdConta": 0,
      "cUrlNotif": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""GerarPix"", ""param"": [{""cCodIntPix"": ""1670867357"", ""nIdCliente"": 0, ""vValor"": 1.99, ""nIdConta"": 0, ""cUrlNotif"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

GerarQrCodePix

altera dadosClaudeMCP

Gera um QrCode estático para pagamentos.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 1Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`nIdConta`	número inteiro	Código da Conta Corrente. Caso não informado, assumirá a conta omie.CASH Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodStatus`	texto
`cCopiaCola`	texto	Código gerado a partir do QR Code para pagamento do PIX.
`cDescStatus`	texto
`cQrCode`	texto	String para a renderização do QR Code PIX.
`cUrlPix`	texto	Link para obter o PDF do QrCode do PIX.

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GerarQrCodePix", "param": [{"nIdConta": 0}]}'

import os
import requests

corpo = {'call': 'GerarQrCodePix', 'param': [{'nIdConta': 0}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "GerarQrCodePix",
    "param": [
      {
        "nIdConta": 0
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "GerarQrCodePix",
    "param": [
        {
            "nIdConta": 0
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "GerarQrCodePix",
  "param": [
    {
      "nIdConta": 0
    }
  ]
}
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": "GerarQrCodePix",
  "param": [
    {
      "nIdConta": 0
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""GerarQrCodePix"", ""param"": [{""nIdConta"": 0}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarPix

consultaClaudeMCP

Obtém a lista de detalhes dos PIX.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cStatus`	texto · até 100	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`dEmissaoAte`	texto · até 10	Filtrar pela data de emissão - Ate.
`dEmissaoDe`	texto · até 10	Filtrar pela data de emissão - de.
`nPagina`	número inteiro
`nRegPorPagina`	número inteiro

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`ListaPix`	lista de objetos
`ListaPix[].cCliente`	número inteiro	Código do Cliente pagador do PIX
`ListaPix[].cCodIntPix`	texto	Código do lançamento gerado pelo integrador.
`ListaPix[].cCopiaCola`	texto	Código gerado a partir do QR Code para pagamento do PIX.
`ListaPix[].cInfo`	objeto	Informações sobre o cadastro do PIX.
`ListaPix[].cInfo.dAlt`	texto	Data da Alteração. No formato dd/mm/aaaa.
`ListaPix[].cInfo.dInc`	texto	Data da Inclusão. No formato dd/mm/aaaa.
`ListaPix[].cInfo.hAlt`	texto	Hora da Alteração. No formato hh:mm:ss.
`ListaPix[].cInfo.hInc`	texto	Hora da Inclusão. No formato hh:mm:ss.
`ListaPix[].cInfo.uAlt`	texto	Usuário da Alteração.
`ListaPix[].cInfo.uInc`	texto	Usuário da Inclusão.
`ListaPix[].cStatus`	texto	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`ListaPix[].cUrlPix`	texto	Link para obter o PDF do QrCode do PIX.
`ListaPix[].dEmissao`	texto	Data de emissão.
`ListaPix[].dVencimento`	texto	Data de vencimento.
`ListaPix[].nCodTitulo`	número inteiro	Código da Conta a Receber.
`ListaPix[].nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
`ListaPix[].vValor`	decimal	Valor do PIX.
`nPagina`	número inteiro
`nRegistros`	número inteiro
`nTotPaginas`	número inteiro
`nTotRegistros`	número inteiro

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarPix", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'

import os
import requests

corpo = {'call': 'ListarPix', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarPix",
    "param": [
      {
        "nPagina": 1,
        "nRegPorPagina": 50
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "ListarPix",
    "param": [
        {
            "nPagina": 1,
            "nRegPorPagina": 50
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "ListarPix",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 50
    }
  ]
}
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": "ListarPix",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 50
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarPix"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarStatusPix

consultaClaudeMCP

Obtém a lista de Status dos PIX.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 5Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cStatus`	texto · até 100	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`dEmissaoAte`	texto · até 10	Filtrar pela data de emissão - Ate.
`dEmissaoDe`	texto · até 10	Filtrar pela data de emissão - de.
`nPagina`	número inteiro
`nRegPorPagina`	número inteiro

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`ListaStatusPix`	lista de objetos
`ListaStatusPix[].cCodIntPix`	texto	Código do lançamento gerado pelo integrador.
`ListaStatusPix[].cStatus`	texto	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`ListaStatusPix[].nCodTitulo`	número inteiro	Chave do Conta a Receber.
`ListaStatusPix[].nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
`ListaStatusPix[].vValor`	decimal	Valor do PIX.
`nPagina`	número inteiro
`nRegistros`	número inteiro
`nTotPaginas`	número inteiro
`nTotRegistros`	número inteiro

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarStatusPix", "param": [{"nPagina": 1, "nRegPorPagina": 50}]}'

import os
import requests

corpo = {'call': 'ListarStatusPix', 'param': [{'nPagina': 1, 'nRegPorPagina': 50}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ListarStatusPix",
    "param": [
      {
        "nPagina": 1,
        "nRegPorPagina": 50
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "ListarStatusPix",
    "param": [
        {
            "nPagina": 1,
            "nRegPorPagina": 50
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "ListarStatusPix",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 50
    }
  ]
}
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": "ListarStatusPix",
  "param": [
    {
      "nPagina": 1,
      "nRegPorPagina": 50
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ListarStatusPix"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ObterPix

consultaClaudeMCP

Obtém os dados doPIX.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntPix`	texto · até 60	Código do lançamento gerado pelo integrador.
`nCodTitulo`	número inteiro	Código do Título a Receber referente ao PIX.
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.

Retorno 12O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCliente`	número inteiro	Código do Cliente pagador do PIX
`cCodIntPix`	texto	Código do lançamento gerado pelo integrador.
`cCopiaCola`	texto	Código gerado a partir do QR Code para pagamento do PIX.
`cInfo`	objeto	Informações sobre o cadastro do PIX.
`cInfo.dAlt`	texto	Data da Alteração. No formato dd/mm/aaaa.
`cInfo.dInc`	texto	Data da Inclusão. No formato dd/mm/aaaa.
`cInfo.hAlt`	texto	Hora da Alteração. No formato hh:mm:ss.
`cInfo.hInc`	texto	Hora da Inclusão. No formato hh:mm:ss.
`cInfo.uAlt`	texto	Usuário da Alteração.
`cInfo.uInc`	texto	Usuário da Inclusão.
`cQrCode`	texto	String para a renderização do QR Code PIX.
`cStatus`	texto	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`cUrlPix`	texto	Link para obter o PDF do QrCode do PIX.
`dEmissao`	texto	Data de emissão.
`dVencimento`	texto	Data de vencimento.
`nCodTitulo`	número inteiro	Código da Conta a Receber.
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
`vValor`	decimal	Valor do PIX.

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterPix", "param": [{"nIdPix": 0, "cCodIntPix": "", "nCodTitulo": 0}]}'

import os
import requests

corpo = {'call': 'ObterPix', 'param': [{'nIdPix': 0, 'cCodIntPix': '', 'nCodTitulo': 0}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ObterPix",
    "param": [
      {
        "nIdPix": 0,
        "cCodIntPix": "",
        "nCodTitulo": 0
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "ObterPix",
    "param": [
        {
            "nIdPix": 0,
            "cCodIntPix": "",
            "nCodTitulo": 0
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "ObterPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": "",
      "nCodTitulo": 0
    }
  ]
}
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": "ObterPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": "",
      "nCodTitulo": 0
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ObterPix"", ""param"": [{""nIdPix"": 0, ""cCodIntPix"": """", ""nCodTitulo"": 0}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ObterStatusPix

consultaClaudeMCP

Obtém o Status de um PIX.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 3Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntPix`	texto · até 60	Código do lançamento gerado pelo integrador.
`nCodTitulo`	número inteiro	Código do Título a Receber referente ao PIX.
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.

Retorno 5O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodIntPix`	texto	Código do lançamento gerado pelo integrador.
`cStatus`	texto	Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO
`nCodTitulo`	número inteiro	Chave da Conta a Receber.
`nIdPix`	número inteiro	ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
`vValor`	decimal	Valor do PIX.

POST /api/v1/financas/pix/

curl -s https://app.omie.com.br/api/v1/financas/pix/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterStatusPix", "param": [{"nIdPix": 0, "cCodIntPix": "", "nCodTitulo": 0}]}'

import os
import requests

corpo = {'call': 'ObterStatusPix', 'param': [{'nIdPix': 0, 'cCodIntPix': '', 'nCodTitulo': 0}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/pix/",
    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/financas/pix/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ObterStatusPix",
    "param": [
      {
        "nIdPix": 0,
        "cCodIntPix": "",
        "nCodTitulo": 0
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/pix/");
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": "ObterStatusPix",
    "param": [
        {
            "nIdPix": 0,
            "cCodIntPix": "",
            "nCodTitulo": 0
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/pix/")
corpo = <<~'JSON'
{
  "call": "ObterStatusPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": "",
      "nCodTitulo": 0
    }
  ]
}
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": "ObterStatusPix",
  "param": [
    {
      "nIdPix": 0,
      "cCodIntPix": "",
      "nCodTitulo": 0
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/pix/"))
    .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/financas/pix/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ObterStatusPix"", ""param"": [{""nIdPix"": 0, ""cCodIntPix"": """", ""nCodTitulo"": 0}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

CancelarPix
GerarPix
GerarQrCodePix
ListarPix
ListarStatusPix
ObterPix
ObterStatusPix