Recursos para IA
Cancelar uma transação

Este endpoint permite cancelar uma transação agendada utilizando o ID de referência obtido na resposta à sua criação. O cancelamento destina-se a permitir a interrupção de operações de pagamento incorretas ou indesejadas antes da conclusão financeira, sendo irreversível visando preservar a integridade operacional e garantir o rastreamento completo para auditoria. Apenas transações que ainda não foram processadas ("pending" e "in_process") podem ser canceladas. Em caso de sucesso, a requisição retornará uma resposta com o status 204.

PUT

https://api.mercadopago.com/v1/payouts/{payout_id}/transactions/{transaction_id}/cancel
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
X-Idempotency-Key
string

OBRIGATÓRIO

Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de dois transações idênticas, por exemplo. Para gar
X-signature
string

OBRIGATÓRIO

Assinatura da requisição com o body criptografado na base 64 com as chaves pública e privada do integrador. É obrigatório apenas no ambiente de produção.
X-enforce-signature
boolean
Booleano para indicar se o integrador irá ou não enviar a assinatura. Deve ser "false" para ambiente de teste, "true" para ambiente produtivo, que é quando é obrigatório o envio da assinatura.
Path
payout_id
string

OBRIGATÓRIO

Identificador do payout que deseja consultar a transação, retornado na resposta à sua criação dentro do campo "id".
transaction_id
string

OBRIGATÓRIO

Identificador da transação que deseja consultar, retornado na resposta à sua criação dentro do campo "id".
Body
comments
string

OBRIGATÓRIO

Justificativa clara e objetiva para o cancelamento (evitar incluir informações pessoais sensíveis). Este campo é fundamental para histórico e auditoria.
deleted_by
string

OBRIGATÓRIO

Identificação única de quem realizou o cancelamento (usuário, sistema, etc). Este campo é fundamental para histórico e auditoria.
Response parameters
This request has no response
Erros

400Requisição inválida. Os parâmetros enviados não são válidos.

invalid_payout_id

Dados inválidos foram enviados no body da requisição. O payout não foi encontrado. Tente enviar a solicitação novamente, validando todos os campos.

invalid_transaction_id

Dados inválidos foram enviados no body da requisição. A transação não foi encontrada. Tente enviar a solicitação novamente, validando todos os campos.

invalid_signature

Dados inválidos foram enviados no body da requisição. Verifique se a secret foi gerada corretamente e está registrada com o Mercado Pago. Verifique também se o body que está enviando é o que foi criptografado.

idempotency_key_required

Dados inválidos foram enviados no body da requisição. A chave de idempotência ("idempotency_key") está ausente. Tente enviar a solicitação novamente, validando todos os campos.

401Erro. Access Token não autorizado.

invalid_token

O Access Token enviado está incorreto. Revise o valor e tente enviar a requisição novamente com a informação correta.

403Proibido. Não tem permissões para acessar este recurso.

forbidden

Sem permissão para acessar o recurso.

404Erro. Payout não encontrado.

not_found

Payout não encontrado. Verifique se o ID enviado está correto.

412Pré-condição não atendida. O status da transação não permite cancelamento.

precondition_failed

O status da transação não permite o seu cancelamento. Apenas transações com "status=pending" ou "status=in_process" podem ser canceladas.

500Erro interno do servidor.

internal_server_error

Ocorreu um erro inesperado no servidor. Tente enviar a requisição novamente.

502Erro de gateway. Falha na integração com um serviço externo.

bad_gateway

Ocorreu um erro na integração com um serviço externo. Tente enviar a requisição novamente.

Request
curl -X PUT \
    'https://api.mercadopago.com/v1/payouts/{payout_id}/transactions/{transaction_id}/cancel'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-1*********685765-12*********1b4332e5c*********e077d7679*********664' \
       -H 'X-Idempotency-Key: 0b7cbb89-eb7f-400c-ad5b-afdb26bc1eff' \
       -H 'X-signature: true' \
       -H 'X-enforce-signature: false' \
       -H 'X-test-token: false' \
    -d '{
  "comments": "delete because the payment was canceled",
  "deleted_by": "user_123"
}'
Response
// Esta requisição não tem resposta.