Pular para o conteúdo principal
PATCH
Cancelar Payout
Cancele um Payout para impedir que os fundos sejam transferidos. Use este recurso para interromper transações criadas por engano ou que precisem de correção.
Note Você só pode cancelar Payouts com status Bloqueado ou Em espera. Para detalhes sobre as transições de status, consulte a documentação Visão geral de Payout.
Este endpoint protege suas transações garantindo que os fundos não sejam enviados ao destinatário errado ou com um valor incorreto.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.

Corpo

application/json
externalId
string
obrigatório

ID da transação a ser anulada.

Resposta

OK

externalId
string
obrigatório

Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e com hífens). Recomendamos o uso do UUID4 para garantir a unicidade.

internalId
string
obrigatório

Identificador de transação da Localpayment.

status
status · object
obrigatório

Status da operação.

Última modificação em 10 de novembro de 2026