Cancelar um Pix

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de cancelamento para o PIX.
O cancelamento de um PIX é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pix é cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento. Veja mais em Listar Comandos de um Pix e Visualizar um Comando.

Eventos de Webhook

Quando a requisição é realizada, um evento pix.command.cancel.started é disparado.
O nosso servidor então começa as tentativas de envio da cancelamento para a instituição financeira.
Somente depois de confirmado na instituição financeira, aí então o pix é cancelado em nosso banco de dados.
Neste momento o evento pix.command.cancel.confirmed é disparado.

O evento pix.db.updated também é disparado na confirmação desta operação.

⚠️

Atenção ao payload de retorno: A resposta da chamada de cancelamento de um PIX é o payload de um Comando. Dentro do payload do comando tem a chave pix com os dados do PIX em questão.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UID do Pix

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json