Pular para o conteúdo principal

Cancelar um Lote de Pagamento

PUT 
/v2/payment/batches/:uid/cancel

Processamento Assíncrono: cria um comando de cancelamento para o Lote de Pagamento.

Quando o provedor financeiro expõe API de cancelamento de lote (ex.: Banco do Brasil), é criado 1 Comando de cancelamento no lote. Para provedores sem API de lote, o cancelamento é feito pagamento a pagamento (fallback per-item). Antes do registro, o lote é cancelado localmente sem interação com provedor.

Eventos de Webhook​

Quando a requisição é realizada, um evento payment.{type}_batch.cancel.requested é disparado. Somente depois de confirmado na instituição financeira o lote é marcado como cancelado, disparando payment.{type}_batch.cancel.confirmed.

Request​

Responses​

Comando de cancelamento criado com sucesso