← Referência das operaçõesCancelarPixaltera dados
Efetua o cancelamento de um PIX
Identificação
| Operação | financas/pix:CancelarPix |
|---|
| 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". |
lDel | boolean | 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 | 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": ""
}
Esta operação altera dados de verdade, na hora. Não existe ambiente de ensaio neste endereço.
apiDocumentaçãoOperações