Nesse artigo, temos:
Gerando o PIX
Quando falamos em geração de PIX, podemos trabalhar com dois métodos:
GerarPix
Com esse método, é possível gerar o Pix para uma conta a receber já existente, se nenhum dado do cliente ou da conta a receber for informado, uma nova conta a receber será criada!
Nesse exemplo, vamos gerar um Pix vinculando a conta a receber já existente no Omie:
{
"call": "GerarPix",
"app_key": "XXXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXXXXX",
"param": [
{
"cCodIntPix": "1670867357",
"nCodTitulo": 1262961171
}
]
}Como informamos a tag "nCodTitulo" não é necessário informar nenhuma outra tag de valor ou dados do cliente, pois ele vai puxar todas as informações da conta a receber!
A response, vem com todos os dados do Pix:
{
"nIdPix": 1262964224,
"cCodIntPix": "1670867357",
"cUrlPix": "XXXXXXXXXXXXXXXXXX",
"cQrCode": "XXXXXXXXXXXX",
"cCopiaCola": "XXXXXXXXXXXXXXXXXX",
"cCodStatus": "0",
"cDescStatus": "PIX gerado com sucesso!"
}📌 Dicas Importantes
A tag "cCodStatus" quando apresenta '0' significa que a solicitação foi executada com sucesso
Se o retorno for maior que '0' ocorreu algum erro durante o processamento da solicitação
A tag 'cDesStatus' descreve o problema ocorrido
Caso queira gerar um Pix criando uma nova conta a receber, pode-se usar esse exemplo de requisição:
{
"call": "GerarPix",
"app_key": "XXXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXX",
"param": [
{
"cCodIntPix": "1670867357",
"vValor": 10.0,
"nIdConta": 23124,
"nIdCliente" OU "cCnpjCpf": 1201934
}
]
}
Lembrando que: 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
GerarQrCodePix
Nesse método, não é possível vincular uma conta a receber existente. Ou seja, ele deve ser usado quando for necessário cobrar por QR Code, mas sem um cliente ou outro dado definido que não seja o valor
Um exemplo de requisição que pode ser enviado é a seguinte:
{
"call": "GerarQrCodePix",
"app_key": "XXXXXXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXXXXXXXX",
"param": [
{
"vValor": 1.74
}
]
}Lembrando que a tag "nIdConta" quando não preenchida, assumirá a Omie.CASH
Esse método em específico não cria a conta a receber! Quando o cliente pagar, será criado automaticamente um lançamento direto no extrato da conta corrente já conciliado:
Como listar os PIX
Para listar os dados do PIX, podemos trabalhar com os seguintes métodos:
Ambos utilizam a mesma estrutura na requisição:
{
"call": "ListarStatusPix",
"app_key": "XXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXX",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 200
}
]
}Porém, os retornos serão diferentes. Confira:
ListarPix
Traz um retorno detalhado da listagem de PIX, com o link de acesso na tag "cUrlPix" e código para pagamento na tag "cCopiaCola". Além disso, traz as datas de vencimento e emissão:
{
"cCodIntPix": "",
"cCopiaCola": "XXXXXXXXXX",
"cStatus": "",
"cUrlPix": "XXXXXXXXXX",
"dEmissao": "10/02/2023",
"dVencimento": "11/02/2023",
"nIdPix": 548097326,
"vValor": 10
}
ListarStatusPix
{
"cCodIntPix": "",
"cStatus": "REGISTRADO",
"nIdPix": 1171377772,
"vValor": 10
}
Como obter dados do PIX
Para obter dados de um PIX específico, podemos trabalhar com os seguintes métodos:
Ambos utilizam a mesma estrutura na requisição:
{
"call": "",
"app_key": "XXXXXXXXXX",
"app_secret": "XXXXXXXXXX",
"param": [
{
"nIdPix": 1171362012
}
]
}
Porém, os retornos são diferentes. Confira:
ObterPix
{
"nIdPix": 1175969877,
"cCodIntPix": "",
"vValor": 5.5,
"dEmissao": "24/11/2022",
"dVencimento": "25/11/2022",
"cUrlPix": "XXXXXXXXXXXXXXXXX",
"cQrCode": "XXXXXXXXXXXXXXXXX",
"cCopiaCola": "XXXXXXXXXXXXXXXXX",
"cStatus": "REGISTRADO",
"cInfo": null
}ObterStatusPix
{
"nIdPix": 1175969877,
"cCodIntPix": "",
"vValor": 5.5,
"cStatus": "REGISTRADO"
}
Cancelando o PIX
Pode ocorrer também de precisarmos cancelar o PIX! Para isso, utilizaremos o método "CancelarPix"
⚠️ Importante
Ao enviarmos a requisição de cancelar Pix, por padrão, a conta a receber também será excluída! Caso não queira que isso aconteça, é necessário enviar a tag "lDel", conforme descrita nos exemplos abaixo!
Caso queira excluir também a conta a receber
Não é necessário o envio da tag "lDel", pois o valor dela por padrão é "True"
{
"call": "CancelarPix",
"app_key": "XXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXX",
"param": [
{
"nIdPix": 1240017623
}
]
}Caso não queira excluir a conta a receber
Deve ser enviada a tag "lDel" com o valor False, conforme exemplo abaixo:
{
"call": "CancelarPix",
"app_key": "XXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXX",
"param": [
{
"nIdPix": 1240017623,
"lDel": "F"
}
]
}
