OmieapiDocumentaçãoOperações
← Referência das operações

GerarPixaltera dados

Gera o QrCode de um PIX.

Identificação

Operaçãofinancas/pix:GerarPix
ServiçoPIX
MóduloFinanças
Endpoint/api/v1/financas/pix/

Parâmetros

CampoTipoDescrição
cCnpjCpfstringCNPJ/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. Preenchimento opcional. 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.
cCodIntPixstringCódigo do lançamento gerado pelo integrador. Preenchimento obrigatório para o método "GerarPix".
cUrlNotifstringURL de CallBack que será acionada quando o pagamento for efetuado. Preenchimento opcional.
nCodTitulointegerID da conta a receber que irá gerar o PIX. Caso essa tag não seja preenchida uma nova conta a receber será gerada. Preenchimento opcional.
nIdClienteintegerCó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. Preenchimento opcional. 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.
nIdContaintegerCódigo da Conta Corrente. Preenchimento Opcional. 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.
vValornumberValor do PIX. Preenchimento obrigatório para o método "GerarPix" quando a tag "nCodTitulo" não for preenchida.

Exemplo de chamada

{
  "cCodIntPix": "1670867357",
  "nIdCliente": 0,
  "vValor": 1.99,
  "nIdConta": 0,
  "cUrlNotif": ""
}
Esta operação altera dados de verdade, na hora. Não existe ambiente de ensaio neste endereço.
api.omie.com.br/mcp · Documentação · Operações