Cancelar um Lote de Pagamento

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.

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

UUID do Lote de Pagamento

Headers
string

Informar um e-mail válido para contatos.

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