Skip to main content
POST
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Acompanhar repasses.
Cancela um repasse em SCHEDULED ou PENDING. Nesses status, nenhum dinheiro saiu da conta de recebimento, então o valor do repasse apenas permanece nela. O cancelamento é irreversível.
Nesta fase, todo repasse é executado logo após o recebimento, então um repasse fica em PENDING por pouquíssimo tempo. O cancelamento ganha uso real com os repasses com data futura (SCHEDULED), previstos para uma próxima fase.

Headers

string
required
Sua API key.
string
required
Número da conta de recebimento.

Path params

string
required
Identificador do repasse (id), obtido em Listar repasses ou em Consultar recebimento com split.

Body

string
required
Motivo do cancelamento. Fica registrado em cancelReason. Até 255 caracteres.

Response

Retorna o repasse atualizado, com status igual a CANCELED e os campos canceledAt e cancelReason preenchidos. A estrutura é a mesma descrita em Listar repasses.

Erros