← Referência das operaçõesObterPixconsulta
Obtém os dados doPIX.
Identificação
| Operação | financas/pix:ObterPix |
|---|
| Serviço | PIX |
|---|
| Módulo | Finanças |
|---|
| Endpoint | /api/v1/financas/pix/ |
|---|
Parâmetros
| Campo | Tipo | Descrição |
|---|
cCodIntPix | string | Código do lançamento gerado pelo integrador.
Preenchimento obrigatório para o método "GerarPix". |
nCodTitulo | integer | Código do Título a Receber referente ao PIX. |
nIdPix | integer | 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. |
Exemplo de chamada
{
"nIdPix": 0,
"cCodIntPix": "",
"nCodTitulo": 0
}
apiDocumentaçãoOperações