Cancelar uma solicitação de limite Pix temporário

Cancela uma solicitação de limite Pix temporário que ainda não foi utilizada, esteja ela aprovada ou em análise manual. Cancelar uma solicitação aprovada libera o volume declarado do teto de aprovação automática da integração; cancelar uma em análise apenas retira o pedido da fila, já que ela ainda não ocupava o teto.

Request

ENDPOINT

/baas/pix/exceptional_pix_request/PIX_REQUEST_KEY/cancel

MÉTODO

POST

cuidado

Disponível somente entre 06:00 e 17:00 (horário de Brasília). Fora dessa janela a resposta é PXT000200.

A requisição não possui corpo.

Path Params

Campo	Tipo	Descrição	Caracteres
pix_request_key	uuidv4	Chave única de identificação da solicitação a ser cancelada.	36

Condições

O cancelamento só é aceito quando todas as condições abaixo são verdadeiras. Qualquer uma delas falsa resulta em PXT000201.

• A solicitação pertence ao solicitante que está chamando.
• A solicitação está em pending_approval ou approved — uma solicitação em rejected, cancelled ou expired não pode ser cancelada.
• Para cancelar a solicitação approved, a conta não pode ter transacionado nenhum volume por Pix temporário no dia. Depois da primeira transferência, mesmo parcial, a conta precisa permanecer com uma solicitação aprovada até as 20:00 — inclusive uma solicitação nova que substituiu a anterior. Uma transferência que terminou recusada não conta como volume transacionado. Para saber de antemão se o cancelamento será aceito, use Consultar o uso do limite Pix temporário. Uma solicitação pending_approval pode ser cancelada a qualquer momento, com ou sem volume transacionado: ela não autoriza nada, e a aprovada continua cobrindo a conta.

informação

Para reduzir ou substituir um limite já utilizado, crie uma nova solicitação para a mesma conta, com total_amount maior ou igual ao volume já transacionado no dia. Uma redução vale na hora; um aumento só passa a valer quando a QI Tech aprovar, e até lá a solicitação anterior continua valendo. Veja Solicitar um limite Pix temporário.

Response

Response Body: 200 OK

{
  "pix_request_key": "9c3b7d21-8f4a-4c2b-9e1d-7a6b5c4d3e2f",
  "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
  "total_amount": 1200000.00,
  "request_reason": "folha de pagamento do cliente Alfa Ltda",
  "status": "cancelled",
  "message": "Request cancelled and no longer available for use."
}

Response Body Params

Campo	Tipo	Descrição
pix_request_key	uuidv4	Chave única de identificação da solicitação cancelada.
account_key	uuidv4	Conta à qual a solicitação se aplicava.
total_amount	number	Volume total que havia sido declarado.
request_reason	string	Motivo informado na solicitação.
status	enumerator	Status da solicitação, cancelled após esta operação.
message	string	Texto descritivo do status, em inglês.

Erros

Os erros específicos de Pix temporário estão em Erros de Pix temporário. Nesta operação podem ocorrer PXT000200 e PXT000201.