BlendFi
OnrampOperações

Cancelamento

POST /v1/conversions/:id/cancel. Válido apenas em awaiting_deposit. Libera reserva e lock.

POST /v1/conversions/:id/cancel encerra uma conversão antes do pagamento Pix chegar. É a saída limpa do awaiting_deposit.

Quando é válido

Apenas em status='awaiting_deposit'. Em qualquer outro estado, a chamada falha com erro de validação.

O que a chamada faz

  1. Transita a conversão para canceled (terminal).
  2. Libera a reserva de limite do cliente final.
  3. Solta o lock (user_id, transaction_type). O cliente final fica livre para iniciar uma nova conversão onramp.

A resposta é a conversão atualizada.

O que a chamada não faz

  • Não recupera Pix pago. Se o cliente final pagou (mesmo durante a chamada de cancel), a conversão já transitou para funded, e cancel não é mais válido.
  • Não invalida o QR Pix imediatamente se a janela ainda estiver aberta no provedor. Recomende ao cliente final não pagar enquanto a UX confirma o cancelamento.

Quando usar

Cancele quando o cliente final desistiu antes de pagar, ou quando você precisa forçar o reset (ex.: o cliente final fechou o app e quer começar de novo).

Reference em breve

A documentação detalhada vai aparecer aqui em conjunto com a disponibilidade da API. Para o desenho conceitual, veja Conversão.

Nesta página