Skip to main content

Cancel a Payment Batch

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

Asynchronous Processing: creates a cancellation command for the Payment Batch.

When the financial provider exposes a batch cancellation API (ex: Banco do Brasil), 1 cancellation Command is created in the batch. For providers without batch API, the cancellation is done payment by payment (fallback per-item). Before registration, the batch is cancelled locally without provider interaction.

Webhook Events​

When the request is made, a payment.{type}_batch.cancel.requested event is triggered. Only after confirmation from the financial institution is the batch marked as cancelled, triggering payment.{type}_batch.cancel.confirmed.

Request​

Responses​

Cancellation command created successfully