Pular para o conteúdo principal
PATCH
Cancelar um Payin
Este endpoint permite cancelar uma transação Payin que esteja autorizada. A transação será marcada como cancelada e quaisquer fundos pendentes serão liberados.

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.

Parâmetros de caminho

externalId
string
obrigatório

ID gerado internamente para rastreabilidade da transação. Deve ser único e aceita apenas caracteres alfanuméricos e hífens (UUID4, por exemplo). Você também pode recuperar o status de uma transação usando seu ID interno.

Pattern: [a-zA-Z0-9\- ]+
Exemplo:

"53025bf4-4c87-4b4f-8fea-b47004440f37"

Corpo

application/json
status
any
obrigatório

Alterar o status para CANCELLED.

Resposta

OK

externalId
string

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

Identificador de transação da Localpayment.

status
status · object

Status da operação.

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